@speclynx/apidom-ns-json-schema-draft-4 3.2.0 → 4.0.0

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

@@ -1,202 +0,0 @@
-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/predicates.cjs

@@ -1,16 +0,0 @@
-"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

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

package/src/refractor/specification.cjs

@@ -1,193 +0,0 @@
-"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: {
-          element: 'jSONSchemaDraft4',
-          $visitor: _index.default,
-          fixedFields: {
-            // core vocabulary
-            id: {
-              $ref: '#/visitors/value',
-              alias: 'idField'
-            },
-            $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: {
-              $visitor: _ItemsVisitor.default,
-              alias: 'itemsField'
-            },
-            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: {
-              $visitor: _LinksVisitor.default,
-              alias: 'linksField'
-            },
-            media: {
-              $ref: '#/visitors/document/objects/Media'
-            },
-            readOnly: {
-              $ref: '#/visitors/value'
-            }
-          }
-        },
-        JSONReference: {
-          element: 'jSONReference',
-          $visitor: _index2.default,
-          fixedFields: {
-            $ref: _$RefVisitor.default
-          }
-        },
-        Media: {
-          element: 'media',
-          $visitor: _index3.default,
-          fixedFields: {
-            binaryEncoding: {
-              $ref: '#/visitors/value'
-            },
-            type: {
-              $ref: '#/visitors/value'
-            }
-          }
-        },
-        LinkDescription: {
-          element: '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;

package/src/refractor/specification.mjs

@@ -1,188 +0,0 @@
-import FallbackVisitor from "./visitors/FallbackVisitor.mjs";
-import JSONSchemaVisitor from "./visitors/json-schema/index.mjs";
-import JSONSchemaItemsVisitor from "./visitors/json-schema/ItemsVisitor.mjs";
-import JSONSchemaRequiredVisitor from "./visitors/json-schema/RequiredVisitor.mjs";
-import JSONSchemaPropertiesVisitor from "./visitors/json-schema/PropertiesVisitor.mjs";
-import JSONSchemaPatternPropertiesVisitor from "./visitors/json-schema/PatternPropertiesVisitor.mjs";
-import JSONSchemaDependenciesVisitor from "./visitors/json-schema/DependenciesVisitor.mjs";
-import JSONSchemaEnumVisitor from "./visitors/json-schema/EnumVisitor.mjs";
-import JSONSchemaTypeVisitor from "./visitors/json-schema/TypeVisitor.mjs";
-import JSONSchemaAllOfVisitor from "./visitors/json-schema/AllOfVisitor.mjs";
-import JSONSchemaAnyOfVisitor from "./visitors/json-schema/AnyOfVisitor.mjs";
-import JSONSchemaOneOfVisitor from "./visitors/json-schema/OneOfVisitor.mjs";
-import JSONSchemaDefinitionsVisitor from "./visitors/json-schema/DefinitionsVisitor.mjs";
-import JSONSchemaLinksVisitor from "./visitors/json-schema/LinksVisitor.mjs";
-import JSONReferenceVisitor from "./visitors/json-schema/json-reference/index.mjs";
-import JSONReference$RefVisitor from "./visitors/json-schema/json-reference/$RefVisitor.mjs";
-import JSONSchemaOrJSONReferenceVisitor from "./visitors/json-schema/JSONSchemaOrJSONReferenceVisitor.mjs";
-import MediaVisitor from "./visitors/json-schema/media/index.mjs";
-import LinkDescriptionVisitor from "./visitors/json-schema/link-description/index.mjs";
-/**
- * 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,
-    JSONSchemaOrJSONReferenceVisitor,
-    document: {
-      objects: {
-        JSONSchema: {
-          element: 'jSONSchemaDraft4',
-          $visitor: JSONSchemaVisitor,
-          fixedFields: {
-            // core vocabulary
-            id: {
-              $ref: '#/visitors/value',
-              alias: 'idField'
-            },
-            $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,
-            items: {
-              $visitor: JSONSchemaItemsVisitor,
-              alias: 'itemsField'
-            },
-            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: JSONSchemaRequiredVisitor,
-            properties: JSONSchemaPropertiesVisitor,
-            additionalProperties: JSONSchemaOrJSONReferenceVisitor,
-            patternProperties: JSONSchemaPatternPropertiesVisitor,
-            dependencies: JSONSchemaDependenciesVisitor,
-            // validation keywords for any instance type
-            enum: JSONSchemaEnumVisitor,
-            type: JSONSchemaTypeVisitor,
-            allOf: JSONSchemaAllOfVisitor,
-            anyOf: JSONSchemaAnyOfVisitor,
-            oneOf: JSONSchemaOneOfVisitor,
-            not: JSONSchemaOrJSONReferenceVisitor,
-            definitions: JSONSchemaDefinitionsVisitor,
-            // 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: {
-              $visitor: JSONSchemaLinksVisitor,
-              alias: 'linksField'
-            },
-            media: {
-              $ref: '#/visitors/document/objects/Media'
-            },
-            readOnly: {
-              $ref: '#/visitors/value'
-            }
-          }
-        },
-        JSONReference: {
-          element: 'jSONReference',
-          $visitor: JSONReferenceVisitor,
-          fixedFields: {
-            $ref: JSONReference$RefVisitor
-          }
-        },
-        Media: {
-          element: 'media',
-          $visitor: MediaVisitor,
-          fixedFields: {
-            binaryEncoding: {
-              $ref: '#/visitors/value'
-            },
-            type: {
-              $ref: '#/visitors/value'
-            }
-          }
-        },
-        LinkDescription: {
-          element: 'linkDescription',
-          $visitor: LinkDescriptionVisitor,
-          fixedFields: {
-            href: {
-              $ref: '#/visitors/value'
-            },
-            rel: {
-              $ref: '#/visitors/value'
-            },
-            title: {
-              $ref: '#/visitors/value'
-            },
-            targetSchema: JSONSchemaOrJSONReferenceVisitor,
-            mediaType: {
-              $ref: '#/visitors/value'
-            },
-            method: {
-              $ref: '#/visitors/value'
-            },
-            encType: {
-              $ref: '#/visitors/value'
-            },
-            schema: JSONSchemaOrJSONReferenceVisitor
-          }
-        }
-      }
-    }
-  }
-};
-export default specification;

package/src/refractor/toolbox.cjs

@@ -1,28 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-var jsonSchemaDraft4Predicates = _interopRequireWildcard(require("../predicates.cjs"));
-var refractorPredicates = _interopRequireWildcard(require("./predicates.cjs"));
-var _namespace = _interopRequireDefault(require("../namespace.cjs"));
-/**
- * @public
- */
-
-const createToolbox = () => {
-  const namespace = new _apidomDatamodel.Namespace();
-  const predicates = {
-    ...refractorPredicates,
-    ...jsonSchemaDraft4Predicates,
-    isStringElement: _apidomDatamodel.isStringElement
-  };
-  namespace.use(_namespace.default);
-  return {
-    predicates,
-    namespace
-  };
-};
-var _default = exports.default = createToolbox;

package/src/refractor/toolbox.mjs

@@ -1,21 +0,0 @@
-import { isStringElement, Namespace } from '@speclynx/apidom-datamodel';
-import * as jsonSchemaDraft4Predicates from "../predicates.mjs";
-import * as refractorPredicates from "./predicates.mjs";
-import jsonSchemaDraft4Namespace from "../namespace.mjs";
-/**
- * @public
- */
-const createToolbox = () => {
-  const namespace = new Namespace();
-  const predicates = {
-    ...refractorPredicates,
-    ...jsonSchemaDraft4Predicates,
-    isStringElement
-  };
-  namespace.use(jsonSchemaDraft4Namespace);
-  return {
-    predicates,
-    namespace
-  };
-};
-export default createToolbox;

package/src/refractor/visitors/FallbackVisitor.cjs

@@ -1,25 +0,0 @@
-"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 _Visitor = _interopRequireDefault(require("./Visitor.cjs"));
-/**
- * This visitor is responsible for falling back to current traversed element
- * Given JSONSchemaVisitor expects ObjectElement to be traversed. If
- * different Element is provided FallBackVisitor is responsible to assigning
- * this Element as current element.
- * @public
- */
-
-/**
- * @public
- */
-class FallbackVisitor extends _Visitor.default {
-  enter(path) {
-    this.element = this.consume ? path.node : (0, _apidomDatamodel.cloneDeep)(path.node);
-    path.stop();
-  }
-}
-var _default = exports.default = FallbackVisitor;