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

package/src/predicates.ts

@@ -0,0 +1,20 @@
+import JSONSchemaElement from './elements/JSONSchema.ts';
+import LinkDescriptionElement from './elements/LinkDescription.ts';
+
+export {
+  isJSONReferenceElement,
+  isMediaElement,
+  isBooleanJSONSchemaElement,
+} from '@speclynx/apidom-ns-json-schema-draft-6';
+
+/**
+ * @public
+ */
+export const isJSONSchemaElement = (element: unknown): element is JSONSchemaElement =>
+  element instanceof JSONSchemaElement;
+
+/**
+ * @public
+ */
+export const isLinkDescriptionElement = (element: unknown): element is LinkDescriptionElement =>
+  element instanceof LinkDescriptionElement;

package/src/refractor/index.cjs

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

@@ -0,0 +1,67 @@
+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/index.ts

@@ -0,0 +1,90 @@
+import { resolveSpecification, dispatchRefractorPlugins } from '@speclynx/apidom-core';
+import { traverse } from '@speclynx/apidom-traverse';
+import { Element, refract as baseRefract } from '@speclynx/apidom-datamodel';
+import { path } from 'ramda';
+import { Visitor as VisitorClass } from '@speclynx/apidom-ns-json-schema-draft-6';
+
+import specification from './specification.ts';
+import createToolbox, { type Toolbox } from './toolbox.ts';
+import type JSONSchemaElement from '../elements/JSONSchema.ts';
+import type LinkDescriptionElement from '../elements/LinkDescription.ts';
+
+/**
+ * @public
+ */
+export type RefractorPlugin = (toolbox: Toolbox) => {
+  visitor?: object;
+  pre?: () => void;
+  post?: () => void;
+};
+
+/**
+ * @public
+ */
+export interface RefractorOptions {
+  readonly element?: string;
+  readonly plugins?: RefractorPlugin[];
+  readonly specificationObj?: typeof specification;
+  readonly consume?: boolean;
+}
+
+/**
+ * @public
+ */
+const refract = <T extends Element>(
+  value: unknown,
+  {
+    element = 'jSONSchemaDraft7',
+    plugins = [],
+    specificationObj = specification,
+    consume = false,
+  }: RefractorOptions = {},
+): T => {
+  const genericElement = baseRefract(value);
+  const resolvedSpec = resolveSpecification(specificationObj);
+  const elementMap = resolvedSpec.elementMap as Record<string, string[]>;
+  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) as new (
+    options: Record<string, unknown>,
+  ) => InstanceType<typeof VisitorClass>;
+  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,
+  }) as T;
+};
+
+/**
+ * Refracts a value into a JSONSchemaElement.
+ * @public
+ */
+export const refractJSONSchema = <T extends Element = JSONSchemaElement>(
+  value: unknown,
+  options: Omit<RefractorOptions, 'element'> = {},
+): T => refract(value, { ...options, element: 'jSONSchemaDraft7' });
+
+/**
+ * Refracts a value into a LinkDescriptionElement.
+ * @public
+ */
+export const refractLinkDescription = <T extends Element = LinkDescriptionElement>(
+  value: unknown,
+  options: Omit<RefractorOptions, 'element'> = {},
+): T => refract(value, { ...options, element: 'linkDescription' });
+
+export default refract;

package/src/refractor/inspect.cjs

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

@@ -0,0 +1,39 @@
+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 };

package/src/refractor/inspect.ts

@@ -0,0 +1,51 @@
+import { resolveSpecification, type ResolvedSpecification } from '@speclynx/apidom-core';
+import { isPlainObject } from 'ramda-adjunct';
+import { JSONReferenceElement } from '@speclynx/apidom-ns-json-schema-draft-6';
+
+import JSONSchemaElement from '../elements/JSONSchema.ts';
+import LinkDescriptionElement from '../elements/LinkDescription.ts';
+import specification from './specification.ts';
+
+/**
+ * @public
+ */
+export interface FixedField {
+  name: string;
+  alias?: string;
+  $visitor: unknown;
+}
+
+interface ResolvedSpec extends ResolvedSpecification {
+  visitors: {
+    document: {
+      objects: Record<string, { fixedFields: Record<string, unknown> }>;
+    };
+  };
+}
+
+// Resolve specification to dereference $ref pointers
+const resolvedSpec = resolveSpecification<ResolvedSpec>(specification);
+
+// Extract fixed fields as list of { name, alias?, $visitor }
+const getFixedFields = (fixedFieldsSpec: Record<string, unknown>): FixedField[] => {
+  return Object.entries(fixedFieldsSpec).map(([name, fieldSpec]) => {
+    if (isPlainObject(fieldSpec)) {
+      return { name, ...fieldSpec } as FixedField;
+    }
+    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 };

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

@@ -0,0 +1,235 @@
+"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"));
+/**
+ * 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-07/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 = {
+  JSONSchemaDraft7Element: {
+    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;
+    },
+    if(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    then(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    else(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    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;
+    }
+  },
+  LinkDescriptionElement: {
+    hrefSchema(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    targetSchema(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    submissionSchema(...args) {
+      return new _JSONSchema.default(...args);
+    },
+    templatePointers(...args) {
+      return new _apidomDatamodel.ObjectElement(...args);
+    },
+    templateRequired(...args) {
+      return new _apidomDatamodel.ArrayElement(...args);
+    },
+    targetHints(...args) {
+      return new _apidomDatamodel.ObjectElement(...args);
+    },
+    headerSchema(...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;