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

package/src/refractor/index.ts

@@ -1,90 +0,0 @@
-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.ts

@@ -1,51 +0,0 @@
-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.ts

@@ -1,260 +0,0 @@
-import {
-  ArrayElement,
-  ObjectElement,
-  StringElement,
-  isArrayElement,
-  isElement,
-  isMemberElement,
-  isStringElement,
-  includesClasses,
-  cloneDeep,
-  SourceMapElement,
-  StyleElement,
-} from '@speclynx/apidom-datamodel';
-import { toValue } from '@speclynx/apidom-core';
-import { Path, getNodeType } from '@speclynx/apidom-traverse';
-
-import JSONSchemaElement from '../../elements/JSONSchema.ts';
-import LinkDescriptionElement from '../../elements/LinkDescription.ts';
-
-/**
- * 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: any) =>
-  isStringElement(element) && includesClasses(element, ['yaml-e-node', 'yaml-e-scalar']);
-
-const schema = {
-  JSONSchemaDraft7Element: {
-    additionalItems(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    items(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    contains(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    required(...args: any[]) {
-      const element = new ArrayElement(...args);
-      element.classes.push('json-schema-required');
-      return element;
-    },
-    properties(...args: any[]) {
-      const element = new ObjectElement(...args);
-      element.classes.push('json-schema-properties');
-      return element;
-    },
-    additionalProperties(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    patternProperties(...args: any[]) {
-      const element = new ObjectElement(...args);
-      element.classes.push('json-schema-patternProperties');
-      return element;
-    },
-    dependencies(...args: any[]) {
-      const element = new ObjectElement(...args);
-      element.classes.push('json-schema-dependencies');
-      return element;
-    },
-    propertyNames(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    enum(...args: any[]) {
-      const element = new ArrayElement(...args);
-      element.classes.push('json-schema-enum');
-      return element;
-    },
-    allOf(...args: any[]) {
-      const element = new ArrayElement(...args);
-      element.classes.push('json-schema-allOf');
-      return element;
-    },
-    anyOf(...args: any[]) {
-      const element = new ArrayElement(...args);
-      element.classes.push('json-schema-anyOf');
-      return element;
-    },
-    oneOf(...args: any[]) {
-      const element = new ArrayElement(...args);
-      element.classes.push('json-schema-oneOf');
-      return element;
-    },
-    if(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    then(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    else(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    not(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    definitions(...args: any[]) {
-      const element = new ObjectElement(...args);
-      element.classes.push('json-schema-definitions');
-      return element;
-    },
-    examples(...args: any[]) {
-      const element = new ArrayElement(...args);
-      element.classes.push('json-schema-examples');
-      return element;
-    },
-    links(...args: any[]) {
-      const element = new ArrayElement(...args);
-      element.classes.push('json-schema-links');
-      return element;
-    },
-  },
-  LinkDescriptionElement: {
-    hrefSchema(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    targetSchema(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    submissionSchema(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-    templatePointers(...args: any[]) {
-      return new ObjectElement(...args);
-    },
-    templateRequired(...args: any[]) {
-      return new ArrayElement(...args);
-    },
-    targetHints(...args: any[]) {
-      return new ObjectElement(...args);
-    },
-    headerSchema(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-  },
-  'json-schema-properties': {
-    '[key: *]': function key(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-  },
-  'json-schema-patternProperties': {
-    '[key: *]': function key(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-  },
-  'json-schema-dependencies': {
-    '[key: *]': function key(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-  },
-  'json-schema-allOf': {
-    '<*>': function asterisk(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-  },
-  'json-schema-anyOf': {
-    '<*>': function asterisk(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-  },
-  'json-schema-oneOf': {
-    '<*>': function asterisk(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-  },
-  'json-schema-definitions': {
-    '[key: *]': function key(...args: any[]) {
-      return new JSONSchemaElement(...args);
-    },
-  },
-  'json-schema-links': {
-    '<*>': function asterisk(...args: any[]) {
-      return new LinkDescriptionElement(...args);
-    },
-  },
-};
-
-const findElementFactory = (ancestor: any, keyName: string) => {
-  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: Path<StringElement>) {
-      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) as string);
-      }
-
-      // 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/specification.ts

@@ -1,88 +0,0 @@
-import { pipe, assocPath, dissocPath } from 'ramda';
-import { specificationObj } from '@speclynx/apidom-ns-json-schema-draft-6';
-
-import JSONSchemaVisitor from './visitors/json-schema/index.ts';
-import LinkDescriptionVisitor from './visitors/json-schema/link-description/index.ts';
-
-const specification = pipe(
-  // JSON Schema object modifications
-  assocPath(['visitors', 'document', 'objects', 'JSONSchema', 'element'], 'jSONSchemaDraft7'),
-  assocPath(['visitors', 'document', 'objects', 'JSONSchema', '$visitor'], JSONSchemaVisitor),
-  assocPath(
-    ['visitors', 'document', 'objects', 'JSONSchema', 'fixedFields', '$comment'],
-    specificationObj.visitors.value,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'JSONSchema', 'fixedFields', 'if'],
-    specificationObj.visitors.JSONSchemaOrJSONReferenceVisitor,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'JSONSchema', 'fixedFields', 'then'],
-    specificationObj.visitors.JSONSchemaOrJSONReferenceVisitor,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'JSONSchema', 'fixedFields', 'else'],
-    specificationObj.visitors.JSONSchemaOrJSONReferenceVisitor,
-  ),
-  dissocPath(['visitors', 'document', 'objects', 'JSONSchema', 'fixedFields', 'media']),
-  assocPath(
-    ['visitors', 'document', 'objects', 'JSONSchema', 'fixedFields', 'contentEncoding'],
-    specificationObj.visitors.value,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'JSONSchema', 'fixedFields', 'contentMediaType'],
-    specificationObj.visitors.value,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'JSONSchema', 'fixedFields', 'writeOnly'],
-    specificationObj.visitors.value,
-  ),
-  // Link Description object modifications
-  assocPath(
-    ['visitors', 'document', 'objects', 'LinkDescription', '$visitor'],
-    LinkDescriptionVisitor,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'LinkDescription', 'fixedFields', 'anchor'],
-    specificationObj.visitors.value,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'LinkDescription', 'fixedFields', 'anchorPointer'],
-    specificationObj.visitors.value,
-  ),
-  dissocPath(['visitors', 'document', 'objects', 'LinkDescription', 'fixedFields', 'mediaType']),
-  assocPath(
-    ['visitors', 'document', 'objects', 'LinkDescription', 'fixedFields', 'targetMediaType'],
-    specificationObj.visitors.value,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'LinkDescription', 'fixedFields', 'targetHints'],
-    specificationObj.visitors.value,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'LinkDescription', 'fixedFields', 'description'],
-    specificationObj.visitors.value,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'LinkDescription', 'fixedFields', '$comment'],
-    specificationObj.visitors.value,
-  ),
-  assocPath(
-    ['visitors', 'document', 'objects', 'LinkDescription', 'fixedFields', 'headerSchema'],
-    specificationObj.visitors.JSONSchemaOrJSONReferenceVisitor,
-  ),
-  dissocPath([
-    'visitors',
-    'document',
-    'objects',
-    'LinkDescription',
-    'fixedFields',
-    'submissionEncType',
-  ]),
-  assocPath(
-    ['visitors', 'document', 'objects', 'LinkDescription', 'fixedFields', 'submissionMediaType'],
-    specificationObj.visitors.value,
-  ),
-)(specificationObj);
-
-export default specification as typeof specificationObj;

package/src/refractor/toolbox.ts

@@ -1,23 +0,0 @@
-import { isStringElement, Namespace } from '@speclynx/apidom-datamodel';
-
-import * as jsonSchemaDraft7Predicates from '../predicates.ts';
-import jsonSchemaDraft7Namespace from '../namespace.ts';
-
-/**
- * @public
- */
-export interface Toolbox {
-  predicates: Record<string, (...args: any[]) => boolean>;
-  namespace: Namespace;
-}
-
-const createToolbox = (): Toolbox => {
-  const namespace = new Namespace();
-  const predicates = { ...jsonSchemaDraft7Predicates, isStringElement };
-
-  namespace.use(jsonSchemaDraft7Namespace);
-
-  return { predicates, namespace };
-};
-
-export default createToolbox;

package/src/refractor/visitors/json-schema/index.ts

@@ -1,27 +0,0 @@
-import { BooleanElement } from '@speclynx/apidom-datamodel';
-import {
-  JSONSchemaVisitor as JSONSchemaDraft6Visitor,
-  JSONSchemaVisitorOptions,
-} from '@speclynx/apidom-ns-json-schema-draft-6';
-
-import JSONSchemaElement from '../../../elements/JSONSchema.ts';
-
-export type { JSONSchemaVisitorOptions };
-
-/**
- * @public
- */
-class JSONSchemaVisitor extends JSONSchemaDraft6Visitor {
-  declare public element: JSONSchemaElement | BooleanElement;
-
-  constructor(options: JSONSchemaVisitorOptions) {
-    super(options);
-    this.element = new JSONSchemaElement();
-  }
-
-  get defaultDialectIdentifier(): string {
-    return 'http://json-schema.org/draft-07/schema#';
-  }
-}
-
-export default JSONSchemaVisitor;

package/src/refractor/visitors/json-schema/link-description/index.ts

@@ -1,22 +0,0 @@
-import {
-  LinkDescriptionVisitor as JSONSchemaDraft6LinkDescriptionVisitor,
-  LinkDescriptionVisitorOptions,
-} from '@speclynx/apidom-ns-json-schema-draft-6';
-
-import LinkDescriptionElement from '../../../../elements/LinkDescription.ts';
-
-export type { LinkDescriptionVisitorOptions };
-
-/**
- * @public
- */
-class LinkDescriptionVisitor extends JSONSchemaDraft6LinkDescriptionVisitor {
-  declare public readonly element: LinkDescriptionElement;
-
-  constructor(options: LinkDescriptionVisitorOptions) {
-    super(options);
-    this.element = new LinkDescriptionElement();
-  }
-}
-
-export default LinkDescriptionVisitor;