@speclynx/apidom-ns-json-schema-draft-6 3.2.1 → 4.0.0

package/src/media-types.mjs

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

package/src/namespace.cjs

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

package/src/namespace.mjs

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

package/src/predicates.cjs

@@ -1,30 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.isMediaElement = exports.isLinkDescriptionElement = exports.isJSONSchemaElement = exports.isJSONReferenceElement = exports.isBooleanJSONSchemaElement = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-var _JSONSchema = _interopRequireDefault(require("./elements/JSONSchema.cjs"));
-var _LinkDescription = _interopRequireDefault(require("./elements/LinkDescription.cjs"));
-var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-4");
-exports.isJSONReferenceElement = _apidomNsJsonSchemaDraft.isJSONReferenceElement;
-exports.isMediaElement = _apidomNsJsonSchemaDraft.isMediaElement;
-/**
- * @public
- */
-const isBooleanJSONSchemaElement = element => {
-  return (0, _apidomDatamodel.isBooleanElement)(element) && (0, _apidomDatamodel.includesClasses)(element, ['boolean-json-schema']);
-};
-
-/**
- * @public
- */
-exports.isBooleanJSONSchemaElement = isBooleanJSONSchemaElement;
-const isJSONSchemaElement = element => element instanceof _JSONSchema.default;
-
-/**
- * @public
- */
-exports.isJSONSchemaElement = isJSONSchemaElement;
-const isLinkDescriptionElement = element => element instanceof _LinkDescription.default;
-exports.isLinkDescriptionElement = isLinkDescriptionElement;

package/src/predicates.mjs

@@ -1,21 +0,0 @@
-import { isBooleanElement, includesClasses } from '@speclynx/apidom-datamodel';
-import JSONSchemaElement from "./elements/JSONSchema.mjs";
-import LinkDescriptionElement from "./elements/LinkDescription.mjs";
-export { isJSONReferenceElement, isMediaElement } from '@speclynx/apidom-ns-json-schema-draft-4';
-
-/**
- * @public
- */
-export const isBooleanJSONSchemaElement = element => {
-  return isBooleanElement(element) && includesClasses(element, ['boolean-json-schema']);
-};
-
-/**
- * @public
- */
-export const isJSONSchemaElement = element => element instanceof JSONSchemaElement;
-
-/**
- * @public
- */
-export const isLinkDescriptionElement = element => element instanceof LinkDescriptionElement;

package/src/refractor/index.cjs

@@ -1,76 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.refractLinkDescription = exports.refractJSONSchema = exports.default = void 0;
-var _apidomCore = require("@speclynx/apidom-core");
-var _apidomTraverse = require("@speclynx/apidom-traverse");
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-var _ramda = require("ramda");
-var _specification = _interopRequireDefault(require("./specification.cjs"));
-var _toolbox = _interopRequireDefault(require("./toolbox.cjs"));
-/**
- * @public
- */
-
-/**
- * @public
- */
-
-/**
- * @public
- */
-const refract = (value, {
-  element = 'jSONSchemaDraft6',
-  plugins = [],
-  specificationObj = _specification.default,
-  consume = false
-} = {}) => {
-  const genericElement = (0, _apidomDatamodel.refract)(value);
-  const resolvedSpec = (0, _apidomCore.resolveSpecification)(specificationObj);
-  const elementMap = resolvedSpec.elementMap;
-  const specPath = elementMap[element];
-  if (!specPath) {
-    throw new Error(`Unknown element type: "${element}"`);
-  }
-
-  /**
-   * 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 own plugins on already transformed ApiDOM.
-   */
-  const RootVisitorClass = (0, _ramda.path)(specPath, resolvedSpec);
-  const rootVisitor = new RootVisitorClass({
-    specObj: resolvedSpec,
-    consume
-  });
-  (0, _apidomTraverse.traverse)(genericElement, rootVisitor);
-
-  /**
-   * Running plugins visitors means extra single traversal === performance hit.
-   */
-  return (0, _apidomCore.dispatchRefractorPlugins)(rootVisitor.element, plugins, {
-    toolboxCreator: _toolbox.default
-  });
-};
-
-/**
- * Refracts a value into a JSONSchemaElement.
- * @public
- */
-const refractJSONSchema = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'jSONSchemaDraft6'
-});
-
-/**
- * Refracts a value into a LinkDescriptionElement.
- * @public
- */
-exports.refractJSONSchema = refractJSONSchema;
-const refractLinkDescription = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'linkDescription'
-});
-exports.refractLinkDescription = refractLinkDescription;
-var _default = exports.default = refract;

package/src/refractor/index.mjs

@@ -1,67 +0,0 @@
-import { resolveSpecification, dispatchRefractorPlugins } from '@speclynx/apidom-core';
-import { traverse } from '@speclynx/apidom-traverse';
-import { refract as baseRefract } from '@speclynx/apidom-datamodel';
-import { path } from 'ramda';
-import specification from "./specification.mjs";
-import createToolbox from "./toolbox.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-/**
- * @public
- */
-const refract = (value, {
-  element = 'jSONSchemaDraft6',
-  plugins = [],
-  specificationObj = specification,
-  consume = false
-} = {}) => {
-  const genericElement = baseRefract(value);
-  const resolvedSpec = resolveSpecification(specificationObj);
-  const elementMap = resolvedSpec.elementMap;
-  const specPath = elementMap[element];
-  if (!specPath) {
-    throw new Error(`Unknown element type: "${element}"`);
-  }
-
-  /**
-   * 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 own plugins on already transformed ApiDOM.
-   */
-  const RootVisitorClass = path(specPath, resolvedSpec);
-  const rootVisitor = new RootVisitorClass({
-    specObj: resolvedSpec,
-    consume
-  });
-  traverse(genericElement, rootVisitor);
-
-  /**
-   * Running plugins visitors means extra single traversal === performance hit.
-   */
-  return dispatchRefractorPlugins(rootVisitor.element, plugins, {
-    toolboxCreator: createToolbox
-  });
-};
-
-/**
- * Refracts a value into a JSONSchemaElement.
- * @public
- */
-export const refractJSONSchema = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'jSONSchemaDraft6'
-});
-
-/**
- * Refracts a value into a LinkDescriptionElement.
- * @public
- */
-export const refractLinkDescription = (value, options = {}) => refract(value, {
-  ...options,
-  element: 'linkDescription'
-});
-export default refract;

package/src/refractor/inspect.cjs

@@ -1,47 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-var _apidomCore = require("@speclynx/apidom-core");
-var _ramdaAdjunct = require("ramda-adjunct");
-var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-4");
-exports.JSONReferenceElement = _apidomNsJsonSchemaDraft.JSONReferenceElement;
-exports.MediaElement = _apidomNsJsonSchemaDraft.MediaElement;
-var _JSONSchema = _interopRequireDefault(require("../elements/JSONSchema.cjs"));
-exports.JSONSchemaElement = _JSONSchema.default;
-var _LinkDescription = _interopRequireDefault(require("../elements/LinkDescription.cjs"));
-exports.LinkDescriptionElement = _LinkDescription.default;
-var _specification = _interopRequireDefault(require("./specification.cjs"));
-/**
- * @public
- */
-
-// Resolve specification to dereference $ref pointers
-const resolvedSpec = (0, _apidomCore.resolveSpecification)(_specification.default);
-
-// Extract fixed fields as list of { name, alias?, $visitor }
-const getFixedFields = fixedFieldsSpec => {
-  return Object.entries(fixedFieldsSpec).map(([name, fieldSpec]) => {
-    if ((0, _ramdaAdjunct.isPlainObject)(fieldSpec)) {
-      return {
-        name,
-        ...fieldSpec
-      };
-    }
-    return {
-      name,
-      $visitor: fieldSpec
-    };
-  });
-};
-
-// Define lazy getters for fixedFields on element classes
-// Note: JSONReferenceElement and MediaElement inherit fixedFields from draft-4
-Object.defineProperty(_JSONSchema.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.JSONSchema.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(_LinkDescription.default, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.LinkDescription.fixedFields),
-  enumerable: true
-});

package/src/refractor/inspect.mjs

@@ -1,39 +0,0 @@
-import { resolveSpecification } from '@speclynx/apidom-core';
-import { isPlainObject } from 'ramda-adjunct';
-import { JSONReferenceElement, MediaElement } from '@speclynx/apidom-ns-json-schema-draft-4';
-import JSONSchemaElement from "../elements/JSONSchema.mjs";
-import LinkDescriptionElement from "../elements/LinkDescription.mjs";
-import specification from "./specification.mjs";
-/**
- * @public
- */
-// Resolve specification to dereference $ref pointers
-const resolvedSpec = resolveSpecification(specification);
-
-// Extract fixed fields as list of { name, alias?, $visitor }
-const getFixedFields = fixedFieldsSpec => {
-  return Object.entries(fixedFieldsSpec).map(([name, fieldSpec]) => {
-    if (isPlainObject(fieldSpec)) {
-      return {
-        name,
-        ...fieldSpec
-      };
-    }
-    return {
-      name,
-      $visitor: fieldSpec
-    };
-  });
-};
-
-// Define lazy getters for fixedFields on element classes
-// Note: JSONReferenceElement and MediaElement inherit fixedFields from draft-4
-Object.defineProperty(JSONSchemaElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.JSONSchema.fixedFields),
-  enumerable: true
-});
-Object.defineProperty(LinkDescriptionElement, 'fixedFields', {
-  get: () => getFixedFields(resolvedSpec.visitors.document.objects.LinkDescription.fixedFields),
-  enumerable: true
-});
-export { JSONSchemaElement, JSONReferenceElement, MediaElement, LinkDescriptionElement };

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

@@ -1,218 +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 _apidomCore = require("@speclynx/apidom-core");
-var _apidomTraverse = require("@speclynx/apidom-traverse");
-var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-4");
-var _JSONSchema = _interopRequireDefault(require("../../elements/JSONSchema.cjs"));
-var _LinkDescription = _interopRequireDefault(require("../../elements/LinkDescription.cjs"));
-/**
- * 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-06/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 = {
-  JSONSchemaDraft6Element: {
-    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 _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;
-    },
-    propertyNames(...args) {
-      return new _JSONSchema.default(...args);
-    },
-    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;
-    },
-    examples(...args) {
-      const element = new _apidomDatamodel.ArrayElement(...args);
-      element.classes.push('json-schema-examples');
-      return element;
-    },
-    links(...args) {
-      const element = new _apidomDatamodel.ArrayElement(...args);
-      element.classes.push('json-schema-links');
-      return element;
-    },
-    media(...args) {
-      return new _apidomNsJsonSchemaDraft.MediaElement(...args);
-    }
-  },
-  LinkDescriptionElement: {
-    hrefSchema(...args) {
-      return new _JSONSchema.default(...args);
-    },
-    targetSchema(...args) {
-      return new _JSONSchema.default(...args);
-    },
-    submissionSchema(...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;