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

package/src/elements/LinkDescription.mjs

@@ -1,134 +0,0 @@
-import { UnsupportedOperationError } from '@speclynx/apidom-error';
-import { LinkDescriptionElement } from '@speclynx/apidom-ns-json-schema-draft-6';
-/**
- * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-01#section-6
- * @public
- */
-
-class LinkDescription extends LinkDescriptionElement {
-  /**
-   * Link context.
-   *
-   * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-hyperschema-01#section-6.1
-   */
-
-  get anchor() {
-    return this.get('anchor');
-  }
-  set anchor(anchor) {
-    this.set('anchor', anchor);
-  }
-  get anchorPointer() {
-    return this.get('anchorPointer');
-  }
-  set anchorPointer(anchorPointer) {
-    this.set('anchorPointer', anchorPointer);
-  }
-
-  /**
-   * Adjusting URI Template Resolution.
-   *
-   * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-hyperschema-01#section-6.4
-   */
-
-  get templatePointers() {
-    return this.get('templatePointers');
-  }
-  set templatePointers(templatePointers) {
-    this.set('templatePointers', templatePointers);
-  }
-  get templateRequired() {
-    return this.get('templateRequired');
-  }
-  set templateRequired(templateRequired) {
-    this.set('templateRequired', templateRequired);
-  }
-
-  /**
-   * Link Target Attributes.
-   *
-   * URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-hyperschema-01#section-6.5
-   */
-
-  get targetSchema() {
-    return this.get('targetSchema');
-  }
-  set targetSchema(targetSchema) {
-    this.set('targetSchema', targetSchema);
-  }
-  get mediaType() {
-    throw new UnsupportedOperationError('mediaType keyword from Hyper-Schema vocabulary has been renamed to targetMediaType.');
-  }
-  set mediaType(mediaType) {
-    throw new UnsupportedOperationError('mediaType keyword from Hyper-Schema vocabulary has been renamed to targetMediaType.');
-  }
-  get targetMediaType() {
-    return this.get('targetMediaType');
-  }
-  set targetMediaType(targetMediaType) {
-    this.set('targetMediaType', targetMediaType);
-  }
-  get targetHints() {
-    return this.get('targetHints');
-  }
-  set targetHints(targetHints) {
-    this.set('targetHints', targetHints);
-  }
-  get description() {
-    return this.get('description');
-  }
-  set description(description) {
-    this.set('description', description);
-  }
-  get $comment() {
-    return this.get('$comment');
-  }
-  set $comment($comment) {
-    this.set('$comment', $comment);
-  }
-
-  /**
-   *  Link Input.
-   *
-   *  URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-hyperschema-01#section-6.6
-   */
-
-  get hrefSchema() {
-    return this.get('hrefSchema');
-  }
-  set hrefSchema(hrefSchema) {
-    this.set('hrefSchema', hrefSchema);
-  }
-  get headerSchema() {
-    return this.get('headerSchema');
-  }
-  set headerSchema(headerSchema) {
-    this.set('headerSchema', headerSchema);
-  }
-
-  /**
-   *  Submitting Data for Processing.
-   *
-   *  URI: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-hyperschema-01#section-6.6.4
-   */
-
-  get submissionSchema() {
-    return this.get('submissionSchema');
-  }
-  set submissionSchema(submissionSchema) {
-    this.set('submissionSchema', submissionSchema);
-  }
-  get submissionEncType() {
-    throw new UnsupportedOperationError('submissionEncType keyword from Hyper-Schema vocabulary has been renamed to submissionMediaType.');
-  }
-  set submissionEncType(submissionEncType) {
-    throw new UnsupportedOperationError('submissionEncType keyword from Hyper-Schema vocabulary has been renamed to submissionMediaType.');
-  }
-  get submissionMediaType() {
-    return this.get('submissionMediaType');
-  }
-  set submissionMediaType(submissionMediaType) {
-    this.set('submissionMediaType', submissionMediaType);
-  }
-}
-export default LinkDescription;

package/src/index.cjs

@@ -1,42 +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.specificationObj = exports.refractorPluginReplaceEmptyElement = exports.refractLinkDescription = exports.refractJSONSchema = exports.refract = exports.mediaTypes = exports.isLinkDescriptionElement = exports.isJSONSchemaElement = exports.isJSONReferenceLikeElement = exports.isJSONReferenceElement = exports.isBooleanJSONSchemaElement = exports.default = exports.Visitor = exports.SpecificationVisitor = exports.PatternedFieldsVisitor = exports.ParentSchemaAwareVisitor = exports.MapVisitor = exports.LinkDescriptionVisitor = exports.LinkDescriptionElement = exports.JSONSchemaVisitor = exports.JSONSchemaElement = exports.JSONSchemaDraft7MediaTypes = exports.JSONReferenceElement = exports.FixedFieldsVisitor = exports.FallbackVisitor = exports.AlternatingVisitor = void 0;
-var _mediaTypes = _interopRequireWildcard(require("./media-types.cjs"));
-exports.mediaTypes = _mediaTypes.default;
-exports.JSONSchemaDraft7MediaTypes = _mediaTypes.JSONSchemaDraft7MediaTypes;
-var _namespace = _interopRequireDefault(require("./namespace.cjs"));
-exports.default = _namespace.default;
-var _replaceEmptyElement = _interopRequireDefault(require("./refractor/plugins/replace-empty-element.cjs"));
-exports.refractorPluginReplaceEmptyElement = _replaceEmptyElement.default;
-var _index = _interopRequireWildcard(require("./refractor/index.cjs"));
-exports.refract = _index.default;
-exports.refractJSONSchema = _index.refractJSONSchema;
-exports.refractLinkDescription = _index.refractLinkDescription;
-var _specification = _interopRequireDefault(require("./refractor/specification.cjs"));
-exports.specificationObj = _specification.default;
-var _predicates = require("./predicates.cjs");
-exports.isBooleanJSONSchemaElement = _predicates.isBooleanJSONSchemaElement;
-exports.isJSONReferenceElement = _predicates.isJSONReferenceElement;
-exports.isJSONSchemaElement = _predicates.isJSONSchemaElement;
-exports.isLinkDescriptionElement = _predicates.isLinkDescriptionElement;
-var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-6");
-exports.isJSONReferenceLikeElement = _apidomNsJsonSchemaDraft.isJSONReferenceLikeElement;
-exports.SpecificationVisitor = _apidomNsJsonSchemaDraft.SpecificationVisitor;
-exports.FallbackVisitor = _apidomNsJsonSchemaDraft.FallbackVisitor;
-exports.FixedFieldsVisitor = _apidomNsJsonSchemaDraft.FixedFieldsVisitor;
-exports.PatternedFieldsVisitor = _apidomNsJsonSchemaDraft.PatternedFieldsVisitor;
-exports.MapVisitor = _apidomNsJsonSchemaDraft.MapVisitor;
-exports.AlternatingVisitor = _apidomNsJsonSchemaDraft.AlternatingVisitor;
-exports.ParentSchemaAwareVisitor = _apidomNsJsonSchemaDraft.ParentSchemaAwareVisitor;
-exports.Visitor = _apidomNsJsonSchemaDraft.Visitor;
-var _index2 = _interopRequireDefault(require("./refractor/visitors/json-schema/index.cjs"));
-exports.JSONSchemaVisitor = _index2.default;
-var _index3 = _interopRequireDefault(require("./refractor/visitors/json-schema/link-description/index.cjs"));
-exports.LinkDescriptionVisitor = _index3.default;
-var _inspect = require("./refractor/inspect.cjs");
-exports.JSONSchemaElement = _inspect.JSONSchemaElement;
-exports.JSONReferenceElement = _inspect.JSONReferenceElement;
-exports.LinkDescriptionElement = _inspect.LinkDescriptionElement;

package/src/index.mjs

@@ -1,13 +0,0 @@
-export { default as mediaTypes, JSONSchemaDraft7MediaTypes } from "./media-types.mjs";
-export { default } from "./namespace.mjs";
-export { default as refractorPluginReplaceEmptyElement } from "./refractor/plugins/replace-empty-element.mjs";
-export { default as refract, refractJSONSchema, refractLinkDescription } from "./refractor/index.mjs";
-export { default as specificationObj } from "./refractor/specification.mjs";
-export { isBooleanJSONSchemaElement, isJSONReferenceElement, isJSONSchemaElement, isLinkDescriptionElement } from "./predicates.mjs";
-export { isJSONReferenceLikeElement, SpecificationVisitor, FallbackVisitor, FixedFieldsVisitor, PatternedFieldsVisitor, MapVisitor, AlternatingVisitor, ParentSchemaAwareVisitor, Visitor } from '@speclynx/apidom-ns-json-schema-draft-6';
-export { default as JSONSchemaVisitor } from "./refractor/visitors/json-schema/index.mjs";
-export { default as LinkDescriptionVisitor } from "./refractor/visitors/json-schema/link-description/index.mjs";
-/**
- * JSON Schema Draft 7 specification elements.
- */
-export { JSONSchemaElement, JSONReferenceElement, LinkDescriptionElement } from "./refractor/inspect.mjs";

package/src/media-types.cjs

@@ -1,34 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = exports.JSONSchemaDraft7MediaTypes = void 0;
-var _ramda = require("ramda");
-var _apidomCore = require("@speclynx/apidom-core");
-/**
- * @public
- */
-
-/**
- * @public
- */
-class JSONSchemaDraft7MediaTypes extends _apidomCore.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 (0, _ramda.last)(this.filterByFormat(format));
-  }
-}
-
-/**
- * @public
- */
-exports.JSONSchemaDraft7MediaTypes = JSONSchemaDraft7MediaTypes;
-const mediaTypes = new JSONSchemaDraft7MediaTypes('application/schema;version=draft-07', 'application/schema+json;version=draft-07', 'application/schema+yaml;version=draft-07');
-var _default = exports.default = mediaTypes;

package/src/media-types.mjs

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

@@ -1,23 +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-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

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

@@ -1,22 +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 _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;
-exports.isMediaElement = _apidomNsJsonSchemaDraft.isMediaElement;
-exports.isBooleanJSONSchemaElement = _apidomNsJsonSchemaDraft.isBooleanJSONSchemaElement;
-/**
- * @public
- */
-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,13 +0,0 @@
-import JSONSchemaElement from "./elements/JSONSchema.mjs";
-import LinkDescriptionElement from "./elements/LinkDescription.mjs";
-export { isJSONReferenceElement, isMediaElement, isBooleanJSONSchemaElement } from '@speclynx/apidom-ns-json-schema-draft-6';
-
-/**
- * @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 = 'jSONSchemaDraft7',
-  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: 'jSONSchemaDraft7'
-});
-
-/**
- * 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 = 'jSONSchemaDraft7',
-  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: 'jSONSchemaDraft7'
-});
-
-/**
- * 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,46 +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-6");
-exports.JSONReferenceElement = _apidomNsJsonSchemaDraft.JSONReferenceElement;
-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 inherits fixedFields from draft-6/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 } from '@speclynx/apidom-ns-json-schema-draft-6';
-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 inherits fixedFields from draft-6/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, LinkDescriptionElement };