@speclynx/apidom-core 1.12.2 → 2.1.0

package/src/traversal/reject.mjs

@@ -1,10 +0,0 @@
-import { complement } from 'ramda';
-import filter from "./filter.mjs";
-/**
- * Complement of filter.
- * @public
- */
-const reject = (predicate, element) => {
-  return filter(complement(predicate), element);
-};
-export default reject;

package/src/traversal/some.cjs

@@ -1,15 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _ramdaAdjunct = require("ramda-adjunct");
-var _find = _interopRequireDefault(require("./find.cjs"));
-/**
- * Tests whether at least one element passes the predicate.
- * @public
- */
-const some = (predicate, element) => {
-  return (0, _ramdaAdjunct.isNotUndefined)((0, _find.default)(predicate, element));
-};
-var _default = exports.default = some;

package/src/traversal/some.mjs

@@ -1,10 +0,0 @@
-import { isNotUndefined } from 'ramda-adjunct';
-import find from "./find.mjs";
-/**
- * Tests whether at least one element passes the predicate.
- * @public
- */
-const some = (predicate, element) => {
-  return isNotUndefined(find(predicate, element));
-};
-export default some;

package/src/traversal/traverse.cjs

@@ -1,60 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = exports.CallbackVisitor = void 0;
-var _ramda = require("ramda");
-var _ramdaAdjunct = require("ramda-adjunct");
-var _visitor = require("./visitor.cjs");
-var _index = require("../predicates/index.cjs");
-/**
- * @public
- */
-
-/**
- * @public
- */
-
-class CallbackVisitor extends _visitor.PredicateVisitor {
-  callback;
-  constructor({
-    callback = _ramdaAdjunct.noop,
-    ...rest
-  } = {}) {
-    super({
-      ...rest
-    });
-    this.callback = callback;
-  }
-  enter(element) {
-    if (this.predicate(element)) {
-      this.callback(element);
-      return this.returnOnTrue;
-    }
-    return this.returnOnFalse;
-  }
-}
-
-/**
- * Executes the callback on this element and all descendants.
- * @public
- */
-exports.CallbackVisitor = CallbackVisitor;
-const traverse = (options, element) => {
-  let callback;
-  let predicate;
-  if ((0, _ramdaAdjunct.isFunction)(options)) {
-    callback = options;
-    predicate = _index.isElement;
-  } else {
-    callback = (0, _ramda.pathOr)(_ramdaAdjunct.noop, ['callback'], options);
-    predicate = (0, _ramda.pathOr)(_index.isElement, ['predicate'], options);
-  }
-  const visitor = new CallbackVisitor({
-    callback,
-    predicate
-  });
-
-  // @ts-ignore
-  (0, _visitor.visit)(element, visitor);
-};
-var _default = exports.default = traverse;

package/src/traversal/traverse.mjs

@@ -1,53 +0,0 @@
-import { pathOr } from 'ramda';
-import { isFunction, noop } from 'ramda-adjunct';
-import { visit, PredicateVisitor } from "./visitor.mjs";
-import { isElement } from "../predicates/index.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-export class CallbackVisitor extends PredicateVisitor {
-  callback;
-  constructor({
-    callback = noop,
-    ...rest
-  } = {}) {
-    super({
-      ...rest
-    });
-    this.callback = callback;
-  }
-  enter(element) {
-    if (this.predicate(element)) {
-      this.callback(element);
-      return this.returnOnTrue;
-    }
-    return this.returnOnFalse;
-  }
-}
-
-/**
- * Executes the callback on this element and all descendants.
- * @public
- */
-const traverse = (options, element) => {
-  let callback;
-  let predicate;
-  if (isFunction(options)) {
-    callback = options;
-    predicate = isElement;
-  } else {
-    callback = pathOr(noop, ['callback'], options);
-    predicate = pathOr(isElement, ['predicate'], options);
-  }
-  const visitor = new CallbackVisitor({
-    callback,
-    predicate
-  });
-
-  // @ts-ignore
-  visit(element, visitor);
-};
-export default traverse;

package/src/traversal/visitor.cjs

@@ -1,123 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.visit = exports.keyMapDefault = exports.isNode = exports.getNodeType = exports.cloneNode = exports.PredicateVisitor = void 0;
-var _ramda = require("ramda");
-var _ramdaAdjunct = require("ramda-adjunct");
-var _apidomAst = require("@speclynx/apidom-ast");
-exports.BREAK = _apidomAst.BREAK;
-exports.mergeAllVisitors = _apidomAst.mergeAllVisitors;
-var _index = require("../predicates/index.cjs");
-var _index2 = require("../clone/index.cjs");
-/**
- * @public
- */
-const getNodeType = element => {
-  /*
-   * We're translating every possible higher element type to primitive minim type here.
-   * We're using polymorphism to recognize any higher element type as ObjectElement or ArrayElement.
-   * Using polymorphism allows us to assume any namespace.
-   *
-   * There is a problem with naming visitor methods described here: https://github.com/babel/babel/discussions/12874
-   */
-  return (0, _index.isObjectElement)(element) ? 'ObjectElement' : (0, _index.isArrayElement)(element) ? 'ArrayElement' : (0, _index.isMemberElement)(element) ? 'MemberElement' : (0, _index.isStringElement)(element) ? 'StringElement' : (0, _index.isBooleanElement)(element) ? 'BooleanElement' : (0, _index.isNumberElement)(element) ? 'NumberElement' : (0, _index.isNullElement)(element) ? 'NullElement' : (0, _index.isLinkElement)(element) ? 'LinkElement' : (0, _index.isRefElement)(element) ? 'RefElement' : undefined;
-};
-
-/**
- * @public
- */
-exports.getNodeType = getNodeType;
-const cloneNode = node => {
-  if ((0, _index.isElement)(node)) {
-    return (0, _index2.cloneShallow)(node);
-  }
-  return (0, _apidomAst.cloneNode)(node);
-};
-
-// isNode :: Node -> Boolean
-exports.cloneNode = cloneNode;
-const isNode = exports.isNode = (0, _ramda.pipe)(getNodeType, _ramdaAdjunct.isString);
-
-/**
- * @public
- */
-const keyMapDefault = exports.keyMapDefault = {
-  ObjectElement: ['content'],
-  ArrayElement: ['content'],
-  MemberElement: ['key', 'value'],
-  StringElement: [],
-  BooleanElement: [],
-  NumberElement: [],
-  NullElement: [],
-  RefElement: [],
-  LinkElement: [],
-  Annotation: [],
-  Comment: [],
-  ParseResultElement: ['content'],
-  SourceMap: ['content']
-};
-class PredicateVisitor {
-  result;
-  predicate;
-  returnOnTrue;
-  returnOnFalse;
-  constructor({
-    predicate = _ramda.F,
-    returnOnTrue,
-    returnOnFalse
-  } = {}) {
-    this.result = [];
-    this.predicate = predicate;
-    this.returnOnTrue = returnOnTrue;
-    this.returnOnFalse = returnOnFalse;
-  }
-  enter(element) {
-    if (this.predicate(element)) {
-      this.result.push(element);
-      return this.returnOnTrue;
-    }
-    return this.returnOnFalse;
-  }
-}
-
-/**
- * @public
- */
-exports.PredicateVisitor = PredicateVisitor;
-const visit = (root,
-// @ts-ignore
-visitor, {
-  keyMap = keyMapDefault,
-  ...rest
-} = {}) => {
-  // @ts-ignore
-  return (0, _apidomAst.visit)(root, visitor, {
-    // @ts-ignore
-    keyMap,
-    // @ts-ignore
-    nodeTypeGetter: getNodeType,
-    nodePredicate: isNode,
-    nodeCloneFn: cloneNode,
-    ...rest
-  });
-};
-
-// @ts-ignore
-exports.visit = visit;
-visit[Symbol.for('nodejs.util.promisify.custom')] = async (root,
-// @ts-ignore
-visitor, {
-  keyMap = keyMapDefault,
-  ...rest
-} = {}) => {
-  // @ts-ignore
-  return _apidomAst.visit[Symbol.for('nodejs.util.promisify.custom')](root, visitor, {
-    // @ts-ignore
-    keyMap,
-    // @ts-ignore
-    nodeTypeGetter: getNodeType,
-    nodePredicate: isNode,
-    nodeCloneFn: cloneNode,
-    ...rest
-  });
-};

package/src/traversal/visitor.mjs

@@ -1,115 +0,0 @@
-import { F as stubFalse, pipe } from 'ramda';
-import { isString } from 'ramda-adjunct';
-import { visit as astVisit, BREAK, mergeAllVisitors, cloneNode as cloneNodeDefault } from '@speclynx/apidom-ast';
-import { isElement, isMemberElement, isArrayElement, isStringElement, isBooleanElement, isLinkElement, isRefElement, isObjectElement, isNullElement, isNumberElement } from "../predicates/index.mjs";
-import { cloneShallow } from "../clone/index.mjs";
-export { BREAK, mergeAllVisitors };
-
-/**
- * @public
- */
-export const getNodeType = element => {
-  /*
-   * We're translating every possible higher element type to primitive minim type here.
-   * We're using polymorphism to recognize any higher element type as ObjectElement or ArrayElement.
-   * Using polymorphism allows us to assume any namespace.
-   *
-   * There is a problem with naming visitor methods described here: https://github.com/babel/babel/discussions/12874
-   */
-  return isObjectElement(element) ? 'ObjectElement' : isArrayElement(element) ? 'ArrayElement' : isMemberElement(element) ? 'MemberElement' : isStringElement(element) ? 'StringElement' : isBooleanElement(element) ? 'BooleanElement' : isNumberElement(element) ? 'NumberElement' : isNullElement(element) ? 'NullElement' : isLinkElement(element) ? 'LinkElement' : isRefElement(element) ? 'RefElement' : undefined;
-};
-
-/**
- * @public
- */
-export const cloneNode = node => {
-  if (isElement(node)) {
-    return cloneShallow(node);
-  }
-  return cloneNodeDefault(node);
-};
-
-// isNode :: Node -> Boolean
-export const isNode = pipe(getNodeType, isString);
-
-/**
- * @public
- */
-export const keyMapDefault = {
-  ObjectElement: ['content'],
-  ArrayElement: ['content'],
-  MemberElement: ['key', 'value'],
-  StringElement: [],
-  BooleanElement: [],
-  NumberElement: [],
-  NullElement: [],
-  RefElement: [],
-  LinkElement: [],
-  Annotation: [],
-  Comment: [],
-  ParseResultElement: ['content'],
-  SourceMap: ['content']
-};
-export class PredicateVisitor {
-  result;
-  predicate;
-  returnOnTrue;
-  returnOnFalse;
-  constructor({
-    predicate = stubFalse,
-    returnOnTrue,
-    returnOnFalse
-  } = {}) {
-    this.result = [];
-    this.predicate = predicate;
-    this.returnOnTrue = returnOnTrue;
-    this.returnOnFalse = returnOnFalse;
-  }
-  enter(element) {
-    if (this.predicate(element)) {
-      this.result.push(element);
-      return this.returnOnTrue;
-    }
-    return this.returnOnFalse;
-  }
-}
-
-/**
- * @public
- */
-export const visit = (root,
-// @ts-ignore
-visitor, {
-  keyMap = keyMapDefault,
-  ...rest
-} = {}) => {
-  // @ts-ignore
-  return astVisit(root, visitor, {
-    // @ts-ignore
-    keyMap,
-    // @ts-ignore
-    nodeTypeGetter: getNodeType,
-    nodePredicate: isNode,
-    nodeCloneFn: cloneNode,
-    ...rest
-  });
-};
-
-// @ts-ignore
-visit[Symbol.for('nodejs.util.promisify.custom')] = async (root,
-// @ts-ignore
-visitor, {
-  keyMap = keyMapDefault,
-  ...rest
-} = {}) => {
-  // @ts-ignore
-  return astVisit[Symbol.for('nodejs.util.promisify.custom')](root, visitor, {
-    // @ts-ignore
-    keyMap,
-    // @ts-ignore
-    nodeTypeGetter: getNodeType,
-    nodePredicate: isNode,
-    nodeCloneFn: cloneNode,
-    ...rest
-  });
-};

package/src/util.cjs

@@ -1,28 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.dereference = void 0;
-var _ramda = require("ramda");
-var _ramdaAdjunct = require("ramda-adjunct");
-/**
- * This dereference algorithm is used exclusively for dereferencing specification objects.
- * It doesn't handle circular references of external references and works on objects only (not arrays).
- * @public
- */
-
-const dereference = (object, root) => {
-  const rootObject = (0, _ramda.defaultTo)(object, root);
-  return (0, _ramda.mapObjIndexed)(val => {
-    if ((0, _ramdaAdjunct.isPlainObject)(val) && (0, _ramda.has)('$ref', val) && (0, _ramda.propSatisfies)(_ramdaAdjunct.isString, '$ref', val)) {
-      const $ref = (0, _ramda.path)(['$ref'], val);
-      // @ts-ignore
-      const pointer = (0, _ramdaAdjunct.trimCharsStart)('#/', $ref);
-      return (0, _ramda.path)(pointer.split('/'), rootObject);
-    }
-    if ((0, _ramdaAdjunct.isPlainObject)(val)) {
-      return dereference(val, rootObject);
-    }
-    return val;
-  }, object);
-};
-exports.dereference = dereference;

package/src/util.mjs

@@ -1,24 +0,0 @@
-import { defaultTo, has, mapObjIndexed, path, propSatisfies } from 'ramda';
-import { isPlainObject, isString, trimCharsStart } from 'ramda-adjunct';
-
-/**
- * This dereference algorithm is used exclusively for dereferencing specification objects.
- * It doesn't handle circular references of external references and works on objects only (not arrays).
- * @public
- */
-
-export const dereference = (object, root) => {
-  const rootObject = defaultTo(object, root);
-  return mapObjIndexed(val => {
-    if (isPlainObject(val) && has('$ref', val) && propSatisfies(isString, '$ref', val)) {
-      const $ref = path(['$ref'], val);
-      // @ts-ignore
-      const pointer = trimCharsStart('#/', $ref);
-      return path(pointer.split('/'), rootObject);
-    }
-    if (isPlainObject(val)) {
-      return dereference(val, rootObject);
-    }
-    return val;
-  }, object);
-};

package/types/minim.d.ts

@@ -1,236 +0,0 @@
-/* eslint-disable spaced-comment, max-classes-per-file */
-/// <reference types="node" />
-
-declare module 'minim' {
-  export type Meta = Record<string, any>;
-  export type Attributes = Record<string, any>;
-  export type Predicate = (element: Element) => boolean;
-  type Callback = (element: Element) => void;
-
-  export function refract(value: any): Element;
-
-  export class Element {
-    static refract(value: any, options?: Record<string, any>): Element;
-
-    public element: string;
-
-    public meta: ObjectElement;
-
-    public attributes: ObjectElement;
-
-    public classes: ArrayElement;
-
-    public children: ArraySlice;
-
-    public parent: Element;
-
-    public content: Array<unknown>;
-
-    constructor(content?: Array<unknown>, meta?: Meta, attributes?: Attributes);
-
-    set id(element: Element);
-
-    get id(): Element;
-
-    equals(value: any): boolean;
-
-    toValue(): any;
-
-    getMetaProperty(name: string, value?: any): any;
-
-    setMetaProperty(name: string, value: any): void;
-
-    freeze(): void;
-
-    clone(): Element;
-
-    primitive(): string | undefined;
-
-    [key: string]: unknown;
-  }
-
-  interface Type<T> extends Element {
-    new (...args: any[]): T;
-  }
-
-  type ExtendingElement<T extends Element = Element> = Record<string, T>;
-
-  export class Namespace {
-    get elements(): Record<string, Element>;
-
-    toRefract(element: Element): JSON;
-
-    toElement(value: any): Element;
-
-    fromRefract(doc: Record<string, any> | Array<any>): Element;
-
-    register(name: string, elementClass: any): Namespace;
-
-    detect(test: any, elementClass: any, givenPrepend: boolean): Namespace;
-
-    use(plugin: NamespacePlugin): Namespace;
-
-    getElementClass(element: string): typeof Element;
-  }
-
-  export interface NamespacePluginOptions {
-    base: Namespace;
-  }
-
-  export interface NamespacePlugin {
-    namespace(options: NamespacePluginOptions): Namespace;
-  }
-
-  export class StringElement extends Element {
-    constructor(content?: string, meta?: Meta, attributes?: Attributes);
-  }
-
-  export class NumberElement extends Element {
-    constructor(content?: number, meta?: Meta, attributes?: Attributes);
-  }
-
-  export class NullElement extends Element {}
-
-  export class BooleanElement extends Element {
-    constructor(content?: boolean, meta?: Meta, attributes?: Attributes);
-  }
-
-  export class ArrayElement extends Element {
-    constructor(content?: unknown[], meta?: Meta, attributes?: Attributes);
-
-    first: Element | undefined;
-
-    second: Element | undefined;
-
-    get(index: string | number): any;
-
-    set(index: string | number, element: Element): void;
-
-    find(predicate: Predicate): ArraySlice;
-
-    findElements(condition: Predicate, givenOptions: any): Array<Element>;
-
-    filter(predicate: Predicate): ArraySlice;
-
-    contains(value: any): boolean;
-
-    includes(value: any): boolean;
-
-    push(value: any): ArrayElement;
-
-    concat(value: ArrayElement): ArrayElement;
-
-    ['fantasy-land/map'](transform: any): ArrayElement;
-
-    forEach(callback: (item: Element, index: number) => void, thisArg?: unknown): void;
-
-    [Symbol.iterator](): IterableIterator<any>;
-
-    get length(): number;
-
-    map(callback: (element: Element) => Element, thisArg?: unknown): Array<Element>;
-  }
-
-  export class ObjectElement extends ArrayElement {
-    constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes);
-
-    remove(name: string): Element;
-
-    set(key: string | StringElement | number, value: any): ObjectElement;
-
-    hasKey(value: string): boolean;
-
-    getKey(value: string): StringElement;
-
-    getMember(key: string): MemberElement;
-
-    // @ts-ignore
-    forEach(
-      callback: (value: Element, key: Element, item: Element) => void,
-      thisArg?: unknown,
-    ): void;
-
-    map(
-      callback: (value: Element, key: Element, member: MemberElement) => MemberElement,
-      thisArg?: unknown,
-    ): Array<MemberElement>;
-
-    keys(): unknown[];
-  }
-
-  export class MemberElement extends Element {
-    constructor(key?: unknown, value?: unknown, meta?: Meta, attributes?: Attributes);
-
-    get key(): unknown;
-
-    set key(key: unknown);
-
-    get value(): unknown;
-
-    set value(value: unknown);
-  }
-
-  export class LinkElement extends Element {
-    constructor(content?: unknown, meta?: Meta, attributes?: Attributes);
-
-    get relation(): string;
-
-    set relation(relation: string);
-
-    get href(): string;
-
-    set href(key: string);
-  }
-
-  export class RefElement extends Element {
-    constructor(content?: unknown, meta?: Meta, attributes?: Attributes);
-
-    get path(): string;
-
-    set path(path: string);
-  }
-
-  export class ArraySlice {
-    constructor(elements?: Array<unknown>);
-
-    get length(): number;
-
-    get first(): Element;
-
-    get isEmpty(): boolean;
-
-    filter(predicate: Predicate, thisArg?: unknown): ArraySlice;
-
-    reject(predicate: Predicate, thisArg?: unknown): ArraySlice;
-
-    forEach(callback: Callback): void;
-
-    reduce<T>(callback: (acc: T, cur: Element) => T, initialValue: T): ArraySlice;
-
-    map(callback: (currentValue: any, index: number) => any, thisArg?: unknown): ArraySlice;
-
-    hasKey(value: string): boolean;
-
-    get<T extends Element>(index: number): T;
-
-    [Symbol.iterator](): IterableIterator<any>;
-
-    toValue(): any;
-
-    clone(): ArraySlice;
-  }
-
-  export class ObjectSlice extends ArraySlice {
-    clone(): ObjectSlice;
-  }
-
-  export class KeyValuePair {
-    public key: Element | undefined;
-
-    public value: Element | undefined;
-
-    constructor(key?: Element, value?: Element);
-
-    clone(): KeyValuePair;
-  }
-}