@swagger-api/apidom-core 0.95.0 → 0.97.0

package/es/identity/index.mjs

@@ -28,7 +28,7 @@ export const IdentityManager = stampit({
       }
 
       // use already assigned identity
-      if (element.meta.hasKey('id') && isStringElement(element.meta.id) && !element.meta.id.equals('')) {
+      if (element.meta.hasKey('id') && isStringElement(element.meta.get('id')) && !element.meta.get('id').equals('')) {
         return element.id;
       }
 

package/es/index.mjs

@@ -45,4 +45,6 @@ export { default as dehydrate } from "./transformers/dehydrate.mjs";
  */
 export { default as toString } from "./transformers/to-string.mjs";
 export { default as sexprs } from "./transformers/sexprs.mjs";
-export { default as deepmerge } from "./deepmerge.mjs";
+export { default as deepmerge } from "./merge/deepmerge.mjs";
+export { default as mergeRight } from "./merge/merge-right.mjs";
+export { default as mergeLeft } from "./merge/merge-left.mjs";

package/es/{deepmerge.mjs → merge/deepmerge.mjs}

@@ -1,11 +1,11 @@
 import { ObjectElement } from 'minim';
-import { isObjectElement, isArrayElement } from "./predicates/index.mjs";
-import { cloneDeep, cloneShallow } from "./clone/index.mjs";
-import toValue from "./transformers/serializers/value/index.mjs";
+import { isObjectElement, isArrayElement } from "../predicates/index.mjs";
+import { cloneDeep, cloneShallow } from "../clone/index.mjs";
+import toValue from "../transformers/serializers/value/index.mjs";
 /* eslint-disable @typescript-eslint/no-use-before-define */
-const emptyElement = element => {
-  const meta = cloneDeep(element.meta);
-  const attributes = cloneDeep(element.attributes);
+export const emptyElement = element => {
+  const meta = element.meta.length > 0 ? cloneDeep(element.meta) : undefined;
+  const attributes = element.attributes.length > 0 ? cloneDeep(element.attributes) : undefined;
 
   // @ts-ignore
   return new element.constructor(undefined, meta, attributes);
@@ -18,6 +18,18 @@ const getMergeFunction = (keyElement, options) => {
   const customMerge = options.customMerge(keyElement, options);
   return typeof customMerge === 'function' ? customMerge : deepmerge;
 };
+const getMetaMergeFunction = options => {
+  if (typeof options.customMetaMerge !== 'function') {
+    return targetMeta => cloneDeep(targetMeta);
+  }
+  return options.customMetaMerge;
+};
+const getAttributesMergeFunction = options => {
+  if (typeof options.customAttributesMerge !== 'function') {
+    return targetAttributes => cloneDeep(targetAttributes);
+  }
+  return options.customAttributesMerge;
+};
 const mergeArrayElement = (targetElement, sourceElement, options) => targetElement.concat(sourceElement)['fantasy-land/map'](item => cloneUnlessOtherwiseSpecified(item, options));
 const mergeObjectElement = (targetElement, sourceElement, options) => {
   const destination = isObjectElement(targetElement) ? emptyElement(targetElement) : emptyElement(sourceElement);
@@ -44,15 +56,17 @@ const mergeObjectElement = (targetElement, sourceElement, options) => {
   });
   return destination;
 };
+export const defaultOptions = {
+  clone: true,
+  isMergeableElement: element => isObjectElement(element) || isArrayElement(element),
+  arrayElementMerge: mergeArrayElement,
+  objectElementMerge: mergeObjectElement,
+  customMerge: undefined,
+  customMetaMerge: undefined,
+  customAttributesMerge: undefined
+};
 export default function deepmerge(targetElement, sourceElement, options) {
   var _mergedOptions$isMerg, _mergedOptions$arrayE, _mergedOptions$object;
-  const defaultOptions = {
-    clone: true,
-    isMergeableElement: element => isObjectElement(element) || isArrayElement(element),
-    arrayElementMerge: mergeArrayElement,
-    objectElementMerge: mergeObjectElement,
-    customMerge: undefined
-  };
   const mergedOptions = {
     ...defaultOptions,
     ...options
@@ -66,10 +80,14 @@ export default function deepmerge(targetElement, sourceElement, options) {
   if (!sourceAndTargetTypesMatch) {
     return cloneUnlessOtherwiseSpecified(sourceElement, mergedOptions);
   }
-  if (sourceIsArrayElement && typeof mergedOptions.arrayElementMerge === 'function') {
-    return mergedOptions.arrayElementMerge(targetElement, sourceElement, mergedOptions);
-  }
-  return mergedOptions.objectElementMerge(targetElement, sourceElement, mergedOptions);
+
+  // merging two elements
+  const mergedElement = sourceIsArrayElement && typeof mergedOptions.arrayElementMerge === 'function' ? mergedOptions.arrayElementMerge(targetElement, sourceElement, mergedOptions) : mergedOptions.objectElementMerge(targetElement, sourceElement, mergedOptions);
+
+  // merging meta & attributes
+  mergedElement.meta = getMetaMergeFunction(mergedOptions)(targetElement.meta, sourceElement.meta);
+  mergedElement.attributes = getAttributesMergeFunction(mergedOptions)(targetElement.attributes, sourceElement.attributes);
+  return mergedElement;
 }
 deepmerge.all = (list, options) => {
   if (!Array.isArray(list)) {

package/es/merge/merge-left.mjs

@@ -0,0 +1,8 @@
+import mergeRight from "./merge-right.mjs";
+const mergeLeft = (...[sourceElement, targetElement, options]) => {
+  return mergeRight(targetElement, sourceElement, options);
+};
+mergeLeft.all = (...[list, options]) => {
+  return mergeRight.all([...list].reverse(), options);
+};
+export default mergeLeft;

package/es/merge/merge-right.mjs

@@ -0,0 +1,23 @@
+import { ObjectElement } from 'minim';
+import deepmerge, { defaultOptions as defaultDeepmergeOptions, emptyElement } from "./deepmerge.mjs";
+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/es/refractor/index.mjs

@@ -1,5 +1,7 @@
 import { dispatchPlugins } from "./plugins/utils/index.mjs";
 import { getNodeType } from "../traversal/visitor.mjs";
+import { cloneDeep } from "../clone/index.mjs";
+import { isElement } from "../predicates/index.mjs";
 import createToolbox from "./toolbox.mjs";
 const refract = (value, {
   Type,
@@ -11,6 +13,14 @@ const refract = (value, {
    * Though we allow consumers to define their onw plugins on already transformed ApiDOM.
    */
   const element = new Type(value);
+  if (isElement(value)) {
+    if (value.meta.length > 0) {
+      element.meta = cloneDeep(value.meta);
+    }
+    if (value.attributes.length > 0) {
+      element.attributes = cloneDeep(value.attributes);
+    }
+  }
 
   /**
    * Run plugins only when necessary.

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

@@ -1,4 +1,3 @@
-import { StringElement } from 'minim';
 import { IdentityManager } from "../../identity/index.mjs";
 /**
  * Plugin for decorating every element in ApiDOM tree with UUID.
@@ -15,7 +14,7 @@ const plugin = ({
     },
     visitor: {
       enter(element) {
-        element.id = new StringElement(identityManager.generateId()); // eslint-disable-line no-param-reassign
+        element.id = identityManager.identify(element); // eslint-disable-line no-param-reassign
       }
     },
     post() {

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

@@ -1,4 +1,3 @@
-import { StringElement } from 'minim';
 import { IdentityManager } from "../../identity/index.mjs";
 /**
  * Plugin for decorating every semantic element in ApiDOM tree with UUID.
@@ -18,7 +17,7 @@ const plugin = ({
     visitor: {
       enter(element) {
         if (!predicates.isPrimitiveElement(element)) {
-          element.id = new StringElement(identityManager.generateId()); // eslint-disable-line no-param-reassign
+          element.id = identityManager.identify(element); // eslint-disable-line no-param-reassign
         }
       }
     },

package/es/transformers/serializers/value/index.mjs

@@ -52,6 +52,20 @@ class Visitor {
   NullElement() {
     return null;
   }
+  RefElement(element, ...rest) {
+    var _ancestors;
+    const ancestors = rest[3];
+    if (((_ancestors = ancestors[ancestors.length - 1]) === null || _ancestors === void 0 ? void 0 : _ancestors.type) === 'EphemeralObject') {
+      return Symbol.for('delete-node');
+    }
+    return String(element.toValue());
+  }
+  LinkElement(element) {
+    if (isStringElement(element.href)) {
+      return element.href.toValue();
+    }
+    return '';
+  }
 }
 const serializer = element => {
   if (!isElement(element)) return element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swagger-api/apidom-core",
-  "version": "0.95.0",
+  "version": "0.97.0",
   "description": "Tools for manipulating ApiDOM structures.",
   "publishConfig": {
     "access": "public",
@@ -30,7 +30,7 @@
     "typescript:check-types": "tsc -p check-types.tsconfig.json --noEmit",
     "typescript:declaration": "tsc -p declaration.tsconfig.json && rollup -c config/rollup/types.dist.js && copyfiles -u 2 ../@types/minim.d.ts ./types && node ../../scripts/file-replace-bof.js './types/dist.d.ts' '/// <reference path=\"./minim.d.ts\" />'",
     "test": "cross-env NODE_ENV=test BABEL_ENV=cjs mocha",
-    "test:update-snapshots": "cross-env UPDATE_SNAPSHOT=1 BABEL_ENV=cjs mocha",
+    "test:update-snapshots": "cross-env UPDATE_SNAPSHOT=1 NODE_ENV=test BABEL_ENV=cjs mocha",
     "prepack": "copyfiles -u 3 ../../LICENSES/* LICENSES && copyfiles -u 2 ../../NOTICE .",
     "postpack": "rimraf NOTICE LICENSES"
   },
@@ -42,8 +42,8 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.20.7",
-    "@swagger-api/apidom-ast": "^0.95.0",
-    "@swagger-api/apidom-error": "^0.95.0",
+    "@swagger-api/apidom-ast": "^0.97.0",
+    "@swagger-api/apidom-error": "^0.97.0",
     "@types/ramda": "~0.29.6",
     "minim": "~0.23.8",
     "ramda": "~0.29.1",
@@ -62,5 +62,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "c56f672154649ce4b6236e4f5e12e05e34867fd7"
+  "gitHead": "b616e76738c48401d651a272daef174f6c1a6510"
 }

package/types/dist.d.ts

@@ -1,4 +1,5 @@
 /// <reference path="./minim.d.ts" />
+import * as minim from 'minim';
 import { Element, StringElement, Meta, Attributes, ArrayElement, ArraySlice, NumberElement, NullElement, BooleanElement, ObjectElement, MemberElement, LinkElement, RefElement, Namespace as Namespace$1, NamespacePlugin, KeyValuePair, ObjectSlice } from 'minim';
 export { ArrayElement, ArraySlice, Attributes, BooleanElement, Element, KeyValuePair, LinkElement, MemberElement, Meta, NamespacePluginOptions, NullElement, NumberElement, ObjectElement, ObjectSlice, RefElement, StringElement, refract } from 'minim';
 import { ApiDOMStructuredError, ApiDOMErrorOptions } from '@swagger-api/apidom-error';
@@ -303,6 +304,8 @@ type ObjectOrArrayElement = ObjectElement | ArrayElement;
 type AnyElement = ObjectElement | ArrayElement | Element;
 type DeepMerge = (targetElement: ObjectOrArrayElement, sourceElement: ObjectOrArrayElement, options?: DeepMergeOptions) => AnyElement;
 type CustomMerge = (keyElement: Element, options: DeepMergeOptions) => DeepMerge;
+type CustomMetaMerge = (targetElementMeta: ObjectElement, sourceElementMeta: ObjectElement) => ObjectElement;
+type CustomAttributesMerge = (targetElementAttributes: ObjectElement, sourceElementAttributes: ObjectElement) => ObjectElement;
 type ArrayElementMerge = (targetElement: ArrayElement, sourceElement: ArrayElement, options: DeepMergeOptions) => ArrayElement;
 type ObjectElementMerge = (targetElement: ObjectElement, source: ObjectElement, options: DeepMergeOptions) => ObjectElement;
 type DeepMergeUserOptions = {
@@ -311,6 +314,8 @@ type DeepMergeUserOptions = {
     arrayElementMerge?: ArrayElementMerge;
     objectElementMerge?: ObjectElementMerge;
     customMerge?: CustomMerge;
+    customMetaMerge?: CustomMetaMerge;
+    customAttributesMerge?: CustomAttributesMerge;
 };
 type DeepMergeOptions = DeepMergeUserOptions & {
     clone: boolean;
@@ -318,10 +323,23 @@ type DeepMergeOptions = DeepMergeUserOptions & {
     arrayElementMerge: ArrayElementMerge;
     objectElementMerge: ObjectElementMerge;
     customMerge: CustomMerge | undefined;
+    customMetaMerge: CustomMetaMerge | undefined;
+    customAttributesMerge: CustomAttributesMerge | undefined;
 };
 declare function deepmerge(targetElement: ObjectOrArrayElement, sourceElement: ObjectOrArrayElement, options?: DeepMergeUserOptions): AnyElement;
 declare namespace deepmerge {
-    var all: (list: ObjectOrArrayElement[], options?: DeepMergeOptions | undefined) => any;
+    var all: (list: ObjectOrArrayElement[], options?: DeepMergeUserOptions | undefined) => any;
 }
 
-export { Annotation as AnnotationElement, CloneError, Comment as CommentElement, DeepCloneError, ElementIdentityError, type ElementPredicate, IdentityManager, MediaTypes, Namespace, ParseResult as ParseResultElement, type Position, type PositionRange, ShallowCloneError, SourceMap as SourceMapElement, Transcluder, cloneDeep, cloneNode, cloneShallow, createNamespace, createPredicate, deepmerge, defaultIdentityManager, dehydrate, dereference, dispatchPlugins as dispatchRefractorPlugins, filter, find, findAtOffset, fromFn as from, getNodeType, hasElementSourceMap, includesClasses, includesSymbols, isAnnotationElement, isArrayElement, isBooleanElement, isElement, isLinkElement, isMemberElement, isNullElement, isNumberElement, isObjectElement, isParseResultElement, isPrimitiveElement, isRefElement, isSourceMapElement, isStringElement, keyMapDefault as keyMap, namespace, parents, plugin$1 as refractorPluginElementIdentity, plugin as refractorPluginSemanticElementIdentity, reject, sexprs, some, serializer$1 as toJSON, toString, serializer$2 as toValue, serializer as toYAML, transclude, traverse, visit };
+type MergeRightOptions = Omit<DeepMergeUserOptions, 'customMerge' | 'clone'>;
+declare const mergeRight: {
+    (targetElement: ObjectOrArrayElement, sourceElement: ObjectOrArrayElement, options?: MergeRightOptions): minim.Element | ObjectElement | minim.ArrayElement;
+    all(list: ObjectOrArrayElement[], options?: MergeRightOptions): any;
+};
+
+declare const mergeLeft: {
+    (targetElement: ObjectOrArrayElement, sourceElement: ObjectOrArrayElement, options?: MergeRightOptions | undefined): minim.Element | minim.ObjectElement | minim.ArrayElement;
+    all(list: ObjectOrArrayElement[], options?: MergeRightOptions | undefined): any;
+};
+
+export { Annotation as AnnotationElement, CloneError, Comment as CommentElement, DeepCloneError, type DeepMergeUserOptions, ElementIdentityError, type ElementPredicate, IdentityManager, MediaTypes, type MergeRightOptions as MergeLeftOptions, type MergeRightOptions, Namespace, type ObjectOrArrayElement, ParseResult as ParseResultElement, type Position, type PositionRange, ShallowCloneError, SourceMap as SourceMapElement, Transcluder, cloneDeep, cloneNode, cloneShallow, createNamespace, createPredicate, deepmerge, defaultIdentityManager, dehydrate, dereference, dispatchPlugins as dispatchRefractorPlugins, filter, find, findAtOffset, fromFn as from, getNodeType, hasElementSourceMap, includesClasses, includesSymbols, isAnnotationElement, isArrayElement, isBooleanElement, isElement, isLinkElement, isMemberElement, isNullElement, isNumberElement, isObjectElement, isParseResultElement, isPrimitiveElement, isRefElement, isSourceMapElement, isStringElement, keyMapDefault as keyMap, mergeLeft, mergeRight, namespace, parents, plugin$1 as refractorPluginElementIdentity, plugin as refractorPluginSemanticElementIdentity, reject, sexprs, some, serializer$1 as toJSON, toString, serializer$2 as toValue, serializer as toYAML, transclude, traverse, visit };

package/types/minim.d.ts

@@ -45,6 +45,8 @@ declare module 'minim' {
     clone(): Element;
 
     primitive(): string | undefined;
+
+    [key: string]: unknown;
   }
 
   interface Type<T> extends Element {
@@ -169,23 +171,23 @@ declare module 'minim' {
   }
 
   export class LinkElement extends Element {
-    constructor(content?: Array<unknown>, meta?: Meta, attributes?: Attributes);
+    constructor(content?: unknown, meta?: Meta, attributes?: Attributes);
 
-    get relation(): unknown;
+    get relation(): string;
 
-    set relation(relation: unknown);
+    set relation(relation: string);
 
-    get href(): unknown;
+    get href(): string;
 
-    set href(key: unknown);
+    set href(key: string);
   }
 
   export class RefElement extends Element {
-    constructor(content?: Array<unknown>, meta?: Meta, attributes?: Attributes);
+    constructor(content?: unknown, meta?: Meta, attributes?: Attributes);
 
-    get path(): unknown;
+    get path(): string;
 
-    set path(path: unknown);
+    set path(path: string);
   }
 
   export class ArraySlice {