@speclynx/apidom-core 4.0.1 → 4.0.3

package/src/merge/merge-right.cjs

@@ -0,0 +1,35 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _deepmerge = _interopRequireWildcard(require("./deepmerge.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+const mergeRight = (targetElement, sourceElement, options) => {
+  const mergedOptions = {
+    ..._deepmerge.defaultOptions,
+    ...options,
+    customMerge: () => (target, source) => source,
+    clone: false
+  };
+  return (0, _deepmerge.default)(targetElement, sourceElement, mergedOptions);
+};
+mergeRight.all = (list, options) => {
+  if (!Array.isArray(list)) {
+    throw new TypeError('First argument of mergeRight should be an array.');
+  }
+  if (list.length === 0) {
+    return new _apidomDatamodel.ObjectElement();
+  }
+  return list.reduce((target, source) => {
+    return mergeRight(target, source, options);
+  }, (0, _deepmerge.emptyElement)(list[0]));
+};
+var _default = exports.default = mergeRight;

package/src/merge/merge-right.mjs

@@ -0,0 +1,29 @@
+import { ObjectElement } from '@speclynx/apidom-datamodel';
+import deepmerge, { defaultOptions as defaultDeepmergeOptions, emptyElement } from "./deepmerge.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+const mergeRight = (targetElement, sourceElement, options) => {
+  const mergedOptions = {
+    ...defaultDeepmergeOptions,
+    ...options,
+    customMerge: () => (target, source) => source,
+    clone: false
+  };
+  return deepmerge(targetElement, sourceElement, mergedOptions);
+};
+mergeRight.all = (list, options) => {
+  if (!Array.isArray(list)) {
+    throw new TypeError('First argument of mergeRight should be an array.');
+  }
+  if (list.length === 0) {
+    return new ObjectElement();
+  }
+  return list.reduce((target, source) => {
+    return mergeRight(target, source, options);
+  }, emptyElement(list[0]));
+};
+export default mergeRight;

package/src/merge/merge-right.ts

@@ -0,0 +1,42 @@
+import { ObjectElement } from '@speclynx/apidom-datamodel';
+
+import deepmerge, { defaultOptions as defaultDeepmergeOptions, emptyElement } from './deepmerge.ts';
+import type { ObjectOrArrayElement, DeepMergeUserOptions, AnyElement } from './deepmerge.ts';
+
+/**
+ * @public
+ */
+export type MergeRightOptions = Omit<DeepMergeUserOptions, 'customMerge' | 'clone'>;
+
+/**
+ * @public
+ */
+const mergeRight = (
+  targetElement: ObjectOrArrayElement,
+  sourceElement: ObjectOrArrayElement,
+  options?: MergeRightOptions,
+): AnyElement => {
+  const mergedOptions = {
+    ...defaultDeepmergeOptions,
+    ...options,
+    customMerge: () => (target: ObjectOrArrayElement, source: ObjectOrArrayElement) => source,
+    clone: false,
+  };
+
+  return deepmerge(targetElement, sourceElement, mergedOptions);
+};
+
+mergeRight.all = (list: ObjectOrArrayElement[], options?: MergeRightOptions) => {
+  if (!Array.isArray(list)) {
+    throw new TypeError('First argument of mergeRight should be an array.');
+  }
+  if (list.length === 0) {
+    return new ObjectElement();
+  }
+
+  return list.reduce((target, source) => {
+    return mergeRight(target, source, options);
+  }, emptyElement(list[0]));
+};
+
+export default mergeRight;

package/src/namespace.cjs

@@ -0,0 +1,10 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+/**
+ * Default namespace instance with all base elements registered.
+ */
+const namespace = new _apidomDatamodel.Namespace();
+var _default = exports.default = namespace;

package/src/namespace.mjs

@@ -0,0 +1,7 @@
+import { Namespace } from '@speclynx/apidom-datamodel';
+
+/**
+ * Default namespace instance with all base elements registered.
+ */
+const namespace = new Namespace();
+export default namespace;

package/src/namespace.ts

@@ -0,0 +1,8 @@
+import { Namespace } from '@speclynx/apidom-datamodel';
+
+/**
+ * Default namespace instance with all base elements registered.
+ */
+const namespace = new Namespace();
+
+export default namespace;

package/src/refractor/plugins/dispatcher/index.cjs

@@ -0,0 +1,64 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.dispatchPluginsSync = exports.dispatchPluginsAsync = void 0;
+var _apidomTraverse = require("@speclynx/apidom-traverse");
+var _ramda = require("ramda");
+var _ramdaAdjunct = require("ramda-adjunct");
+var _toolbox = _interopRequireDefault(require("../../toolbox.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+const defaultDispatchPluginsOptions = {
+  toolboxCreator: _toolbox.default,
+  visitorOptions: {
+    exposeEdits: true
+  }
+};
+
+/**
+ * @public
+ */
+const dispatchPluginsSync = (element, plugins, options = {}) => {
+  if (plugins.length === 0) return element;
+  const mergedOptions = (0, _ramda.mergeDeepRight)(defaultDispatchPluginsOptions, options);
+  const {
+    toolboxCreator,
+    visitorOptions
+  } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
+  const mergedPluginsVisitor = (0, _apidomTraverse.mergeVisitors)(pluginsSpecs.map((0, _ramda.propOr)({}, 'visitor')), visitorOptions);
+  pluginsSpecs.forEach((0, _ramdaAdjunct.invokeArgs)(['pre'], []));
+  const newElement = (0, _apidomTraverse.traverse)(element, mergedPluginsVisitor);
+  pluginsSpecs.forEach((0, _ramdaAdjunct.invokeArgs)(['post'], []));
+  return newElement;
+};
+exports.dispatchPluginsSync = dispatchPluginsSync;
+const dispatchPluginsAsync = async (element, plugins, options = {}) => {
+  if (plugins.length === 0) return element;
+  const mergedOptions = (0, _ramda.mergeDeepRight)(defaultDispatchPluginsOptions, options);
+  const {
+    toolboxCreator,
+    visitorOptions
+  } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
+  const mergedPluginsVisitor = (0, _apidomTraverse.mergeVisitorsAsync)(pluginsSpecs.map((0, _ramda.propOr)({}, 'visitor')), visitorOptions);
+  await Promise.allSettled(pluginsSpecs.map((0, _ramdaAdjunct.invokeArgs)(['pre'], [])));
+  const newElement = await (0, _apidomTraverse.traverseAsync)(element, mergedPluginsVisitor);
+  await Promise.allSettled(pluginsSpecs.map((0, _ramdaAdjunct.invokeArgs)(['post'], [])));
+  return newElement;
+};
+exports.dispatchPluginsAsync = dispatchPluginsAsync;
+dispatchPluginsSync[Symbol.for('nodejs.util.promisify.custom')] = dispatchPluginsAsync;

package/src/refractor/plugins/dispatcher/index.mjs

@@ -0,0 +1,54 @@
+import { traverse, traverseAsync, mergeVisitors, mergeVisitorsAsync } from '@speclynx/apidom-traverse';
+import { mergeDeepRight, propOr } from 'ramda';
+import { invokeArgs } from 'ramda-adjunct';
+import createToolbox from "../../toolbox.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+const defaultDispatchPluginsOptions = {
+  toolboxCreator: createToolbox,
+  visitorOptions: {
+    exposeEdits: true
+  }
+};
+
+/**
+ * @public
+ */
+export const dispatchPluginsSync = (element, plugins, options = {}) => {
+  if (plugins.length === 0) return element;
+  const mergedOptions = mergeDeepRight(defaultDispatchPluginsOptions, options);
+  const {
+    toolboxCreator,
+    visitorOptions
+  } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
+  const mergedPluginsVisitor = mergeVisitors(pluginsSpecs.map(propOr({}, 'visitor')), visitorOptions);
+  pluginsSpecs.forEach(invokeArgs(['pre'], []));
+  const newElement = traverse(element, mergedPluginsVisitor);
+  pluginsSpecs.forEach(invokeArgs(['post'], []));
+  return newElement;
+};
+export const dispatchPluginsAsync = async (element, plugins, options = {}) => {
+  if (plugins.length === 0) return element;
+  const mergedOptions = mergeDeepRight(defaultDispatchPluginsOptions, options);
+  const {
+    toolboxCreator,
+    visitorOptions
+  } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
+  const mergedPluginsVisitor = mergeVisitorsAsync(pluginsSpecs.map(propOr({}, 'visitor')), visitorOptions);
+  await Promise.allSettled(pluginsSpecs.map(invokeArgs(['pre'], [])));
+  const newElement = await traverseAsync(element, mergedPluginsVisitor);
+  await Promise.allSettled(pluginsSpecs.map(invokeArgs(['post'], [])));
+  return newElement;
+};
+dispatchPluginsSync[Symbol.for('nodejs.util.promisify.custom')] = dispatchPluginsAsync;

package/src/refractor/plugins/dispatcher/index.ts

@@ -0,0 +1,102 @@
+import { Element } from '@speclynx/apidom-datamodel';
+import {
+  traverse,
+  traverseAsync,
+  mergeVisitors,
+  mergeVisitorsAsync,
+} from '@speclynx/apidom-traverse';
+import { mergeDeepRight, propOr } from 'ramda';
+import { invokeArgs } from 'ramda-adjunct';
+
+import createToolbox from '../../toolbox.ts';
+
+/**
+ * @public
+ */
+export interface DispatchPluginsOptions {
+  toolboxCreator: typeof createToolbox;
+  visitorOptions: {
+    exposeEdits: boolean;
+  };
+}
+
+/**
+ * @public
+ */
+export interface DispatchPluginsSync {
+  <T extends Element, U extends Element = Element>(
+    element: T,
+    plugins: ((toolbox: any) => object)[],
+    options?: Record<string, unknown>,
+  ): U;
+  [key: symbol]: DispatchPluginsAsync;
+}
+
+/**
+ * @public
+ */
+export interface DispatchPluginsAsync {
+  <T extends Element, U extends Element = Element>(
+    element: T,
+    plugins: ((toolbox: any) => object)[],
+    options?: Record<string, unknown>,
+  ): Promise<U>;
+}
+
+const defaultDispatchPluginsOptions: DispatchPluginsOptions = {
+  toolboxCreator: createToolbox,
+  visitorOptions: {
+    exposeEdits: true,
+  },
+};
+
+/**
+ * @public
+ */
+export const dispatchPluginsSync: DispatchPluginsSync = ((element, plugins, options = {}) => {
+  if (plugins.length === 0) return element;
+
+  const mergedOptions = mergeDeepRight(
+    defaultDispatchPluginsOptions,
+    options,
+  ) as DispatchPluginsOptions;
+  const { toolboxCreator, visitorOptions } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map((plugin) => plugin(toolbox));
+  const mergedPluginsVisitor = mergeVisitors(
+    pluginsSpecs.map(propOr({}, 'visitor')) as object[],
+    visitorOptions,
+  );
+
+  pluginsSpecs.forEach(invokeArgs(['pre'], []));
+  const newElement = traverse(element, mergedPluginsVisitor);
+  pluginsSpecs.forEach(invokeArgs(['post'], []));
+  return newElement;
+}) as DispatchPluginsSync;
+
+export const dispatchPluginsAsync: DispatchPluginsAsync = (async (
+  element,
+  plugins,
+  options = {},
+) => {
+  if (plugins.length === 0) return element;
+
+  const mergedOptions = mergeDeepRight(
+    defaultDispatchPluginsOptions,
+    options,
+  ) as DispatchPluginsOptions;
+  const { toolboxCreator, visitorOptions } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map((plugin) => plugin(toolbox));
+  const mergedPluginsVisitor = mergeVisitorsAsync(
+    pluginsSpecs.map(propOr({}, 'visitor')) as object[],
+    visitorOptions,
+  );
+
+  await Promise.allSettled(pluginsSpecs.map(invokeArgs(['pre'], [])));
+  const newElement = await traverseAsync(element, mergedPluginsVisitor);
+  await Promise.allSettled(pluginsSpecs.map(invokeArgs(['post'], [])));
+  return newElement;
+}) as DispatchPluginsAsync;
+
+dispatchPluginsSync[Symbol.for('nodejs.util.promisify.custom')] = dispatchPluginsAsync;

package/src/refractor/plugins/element-identity.cjs

@@ -0,0 +1,31 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _index = require("../../identity/index.cjs");
+/**
+ * Plugin for decorating every element in ApiDOM tree with UUID.
+ * @public
+ */
+
+const plugin = ({
+  length = 6
+} = {}) => () => {
+  let identityManager;
+  return {
+    pre() {
+      identityManager = new _index.IdentityManager({
+        length
+      });
+    },
+    visitor: {
+      enter(path) {
+        path.node.id = identityManager.identify(path.node);
+      }
+    },
+    post() {
+      identityManager = null;
+    }
+  };
+};
+var _default = exports.default = plugin;

package/src/refractor/plugins/element-identity.mjs

@@ -0,0 +1,26 @@
+import { IdentityManager } from "../../identity/index.mjs";
+/**
+ * Plugin for decorating every element in ApiDOM tree with UUID.
+ * @public
+ */
+const plugin = ({
+  length = 6
+} = {}) => () => {
+  let identityManager;
+  return {
+    pre() {
+      identityManager = new IdentityManager({
+        length
+      });
+    },
+    visitor: {
+      enter(path) {
+        path.node.id = identityManager.identify(path.node);
+      }
+    },
+    post() {
+      identityManager = null;
+    }
+  };
+};
+export default plugin;

package/src/refractor/plugins/element-identity.ts

@@ -0,0 +1,31 @@
+import { Element } from '@speclynx/apidom-datamodel';
+import { Path } from '@speclynx/apidom-traverse';
+
+import { IdentityManager } from '../../identity/index.ts';
+
+/**
+ * Plugin for decorating every element in ApiDOM tree with UUID.
+ * @public
+ */
+
+const plugin =
+  ({ length = 6 } = {}) =>
+  () => {
+    let identityManager: IdentityManager | null;
+
+    return {
+      pre() {
+        identityManager = new IdentityManager({ length });
+      },
+      visitor: {
+        enter(path: Path<Element>) {
+          path.node.id = identityManager!.identify(path.node);
+        },
+      },
+      post() {
+        identityManager = null;
+      },
+    };
+  };
+
+export default plugin;

package/src/refractor/plugins/semantic-element-identity.cjs

@@ -0,0 +1,33 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _index = require("../../identity/index.cjs");
+/**
+ * Plugin for decorating every semantic element in ApiDOM tree with UUID.
+ * @public
+ */
+const plugin = ({
+  length = 6
+} = {}) => () => {
+  let identityManager;
+  return {
+    pre() {
+      identityManager = new _index.IdentityManager({
+        length
+      });
+    },
+    visitor: {
+      enter(path) {
+        if (!(0, _apidomDatamodel.isPrimitiveElement)(path.node)) {
+          path.node.id = identityManager.identify(path.node);
+        }
+      }
+    },
+    post() {
+      identityManager = null;
+    }
+  };
+};
+var _default = exports.default = plugin;

package/src/refractor/plugins/semantic-element-identity.mjs

@@ -0,0 +1,29 @@
+import { isPrimitiveElement } from '@speclynx/apidom-datamodel';
+import { IdentityManager } from "../../identity/index.mjs";
+/**
+ * Plugin for decorating every semantic element in ApiDOM tree with UUID.
+ * @public
+ */
+const plugin = ({
+  length = 6
+} = {}) => () => {
+  let identityManager;
+  return {
+    pre() {
+      identityManager = new IdentityManager({
+        length
+      });
+    },
+    visitor: {
+      enter(path) {
+        if (!isPrimitiveElement(path.node)) {
+          path.node.id = identityManager.identify(path.node);
+        }
+      }
+    },
+    post() {
+      identityManager = null;
+    }
+  };
+};
+export default plugin;

package/src/refractor/plugins/semantic-element-identity.ts

@@ -0,0 +1,32 @@
+import { Element, isPrimitiveElement } from '@speclynx/apidom-datamodel';
+import { Path } from '@speclynx/apidom-traverse';
+
+import { IdentityManager } from '../../identity/index.ts';
+
+/**
+ * Plugin for decorating every semantic element in ApiDOM tree with UUID.
+ * @public
+ */
+const plugin =
+  ({ length = 6 } = {}) =>
+  () => {
+    let identityManager: IdentityManager | null;
+
+    return {
+      pre() {
+        identityManager = new IdentityManager({ length });
+      },
+      visitor: {
+        enter(path: Path<Element>) {
+          if (!isPrimitiveElement(path.node)) {
+            path.node.id = identityManager!.identify(path.node);
+          }
+        },
+      },
+      post() {
+        identityManager = null;
+      },
+    };
+  };
+
+export default plugin;

package/src/refractor/toolbox.cjs

@@ -0,0 +1,47 @@
+"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 _namespace = _interopRequireDefault(require("../namespace.cjs"));
+/**
+ * @public
+ */
+
+const predicates = {
+  isElement: _apidomDatamodel.isElement,
+  isStringElement: _apidomDatamodel.isStringElement,
+  isNumberElement: _apidomDatamodel.isNumberElement,
+  isNullElement: _apidomDatamodel.isNullElement,
+  isBooleanElement: _apidomDatamodel.isBooleanElement,
+  isArrayElement: _apidomDatamodel.isArrayElement,
+  isObjectElement: _apidomDatamodel.isObjectElement,
+  isMemberElement: _apidomDatamodel.isMemberElement,
+  isPrimitiveElement: _apidomDatamodel.isPrimitiveElement,
+  isLinkElement: _apidomDatamodel.isLinkElement,
+  isRefElement: _apidomDatamodel.isRefElement,
+  isAnnotationElement: _apidomDatamodel.isAnnotationElement,
+  isCommentElement: _apidomDatamodel.isCommentElement,
+  isParseResultElement: _apidomDatamodel.isParseResultElement,
+  isSourceMapElement: _apidomDatamodel.isSourceMapElement,
+  hasElementStyle: _apidomDatamodel.hasElementStyle,
+  hasElementSourceMap: _apidomDatamodel.hasElementSourceMap,
+  includesSymbols: _apidomDatamodel.includesSymbols,
+  includesClasses: _apidomDatamodel.includesClasses
+};
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+const createToolbox = () => {
+  return {
+    predicates,
+    namespace: _namespace.default
+  };
+};
+var _default = exports.default = createToolbox;

package/src/refractor/toolbox.mjs

@@ -0,0 +1,41 @@
+import { isElement, isStringElement, isNumberElement, isNullElement, isBooleanElement, isArrayElement, isObjectElement, isMemberElement, isPrimitiveElement, isLinkElement, isRefElement, isAnnotationElement, isCommentElement, isParseResultElement, isSourceMapElement, hasElementStyle, hasElementSourceMap, includesSymbols, includesClasses } from '@speclynx/apidom-datamodel';
+import defaultNamespace from "../namespace.mjs";
+/**
+ * @public
+ */
+const predicates = {
+  isElement,
+  isStringElement,
+  isNumberElement,
+  isNullElement,
+  isBooleanElement,
+  isArrayElement,
+  isObjectElement,
+  isMemberElement,
+  isPrimitiveElement,
+  isLinkElement,
+  isRefElement,
+  isAnnotationElement,
+  isCommentElement,
+  isParseResultElement,
+  isSourceMapElement,
+  hasElementStyle,
+  hasElementSourceMap,
+  includesSymbols,
+  includesClasses
+};
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+const createToolbox = () => {
+  return {
+    predicates,
+    namespace: defaultNamespace
+  };
+};
+export default createToolbox;