@swagger-api/apidom-core 0.76.2 → 0.77.0

package/es/clone/errors/DeepCloneError.mjs

@@ -0,0 +1,3 @@
+import CloneError from "./CloneError.mjs";
+class DeepCloneError extends CloneError {}
+export default DeepCloneError;

package/es/clone/errors/ShallowCloneError.mjs

@@ -0,0 +1,3 @@
+import CloneError from "./CloneError.mjs";
+class ShallowCloneError extends CloneError {}
+export default ShallowCloneError;

package/es/clone/index.mjs

@@ -0,0 +1,98 @@
+import { ArraySlice, ObjectSlice, KeyValuePair } from 'minim';
+import { isElement } from "../predicates/index.mjs";
+import DeepCloneError from "./errors/DeepCloneError.mjs";
+import ShallowCloneError from "./errors/ShallowCloneError.mjs";
+const invokeClone = value => {
+  if (typeof (value === null || value === void 0 ? void 0 : value.clone) === 'function') {
+    return value.clone();
+  }
+  return value;
+};
+export const cloneDeep = value => {
+  if (value instanceof ObjectSlice) {
+    const items = [...value].map(invokeClone);
+    return new ObjectSlice(items);
+  }
+  if (value instanceof ArraySlice) {
+    const items = [...value].map(invokeClone);
+    return new ArraySlice(items);
+  }
+  if (typeof (value === null || value === void 0 ? void 0 : value.clone) === 'function') {
+    return value.clone();
+  }
+  throw new DeepCloneError("Value provided to cloneDeep function couldn't be cloned", {
+    value
+  });
+};
+cloneDeep.safe = value => {
+  try {
+    return cloneDeep(value);
+  } catch {
+    return value;
+  }
+};
+const cloneShallowKeyValuePair = keyValuePair => {
+  const {
+    key,
+    value
+  } = keyValuePair;
+  return new KeyValuePair(key, value);
+};
+const cloneShallowArraySlice = arraySlice => {
+  const items = [...arraySlice];
+  return new ArraySlice(items);
+};
+const cloneShallowObjectSlice = objectSlice => {
+  const items = [...objectSlice];
+  return new ObjectSlice(items);
+};
+
+/* eslint-disable no-underscore-dangle */
+const cloneShallowElement = element => {
+  // @ts-ignore
+  const copy = new element.constructor();
+  copy.element = element.element;
+  if (element.meta.length > 0) {
+    copy._meta = cloneDeep(element.meta);
+  }
+  if (element.attributes.length > 0) {
+    copy._attributes = cloneDeep(element.attributes);
+  }
+  if (isElement(element.content)) {
+    const content = element.content;
+    copy.content = cloneShallowElement(content);
+  } else if (Array.isArray(element.content)) {
+    copy.content = [...element.content];
+  } else if (element.content instanceof KeyValuePair) {
+    copy.content = cloneShallowKeyValuePair(element.content);
+  } else {
+    copy.content = element.content;
+  }
+  return copy;
+};
+/* eslint-enable */
+
+export const cloneShallow = value => {
+  if (value instanceof KeyValuePair) {
+    return cloneShallowKeyValuePair(value);
+  }
+  if (value instanceof ObjectSlice) {
+    return cloneShallowObjectSlice(value);
+  }
+  if (value instanceof ArraySlice) {
+    return cloneShallowArraySlice(value);
+  }
+  if (isElement(value)) {
+    return cloneShallowElement(value);
+  }
+  throw new ShallowCloneError("Value provided to cloneShallow function couldn't be cloned", {
+    value
+  });
+};
+cloneShallow.safe = value => {
+  try {
+    return cloneShallow(value);
+  } catch {
+    return value;
+  }
+};

package/es/deepmerge.mjs

@@ -1,14 +1,15 @@
-import { ObjectElement, MemberElement } from 'minim';
+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";
 /* eslint-disable @typescript-eslint/no-use-before-define */
 const emptyElement = element => {
-  const meta = element.meta.clone();
-  const attributes = element.attributes.clone();
+  const meta = cloneDeep(element.meta);
+  const attributes = cloneDeep(element.attributes);
 
   // @ts-ignore
   return new element.constructor(undefined, meta, attributes);
 };
-const cloneMemberElement = memberElement => new MemberElement(memberElement.key, memberElement.value, memberElement.meta.clone(), memberElement.attributes.clone());
 const cloneUnlessOtherwiseSpecified = (element, options) => options.clone && options.isMergeableElement(element) ? deepmerge(emptyElement(element), element, options) : element;
 const getMergeFunction = (keyElement, options) => {
   if (typeof options.customMerge !== 'function') {
@@ -22,20 +23,20 @@ const mergeObjectElement = (targetElement, sourceElement, options) => {
   const destination = isObjectElement(targetElement) ? emptyElement(targetElement) : emptyElement(sourceElement);
   if (isObjectElement(targetElement)) {
     targetElement.forEach((value, key, member) => {
-      const clonedMember = cloneMemberElement(member);
+      const clonedMember = cloneShallow(member);
       clonedMember.value = cloneUnlessOtherwiseSpecified(value, options);
       destination.content.push(clonedMember);
     });
   }
   sourceElement.forEach((value, key, member) => {
-    const keyValue = key.toValue();
+    const keyValue = toValue(key);
     let clonedMember;
     if (isObjectElement(targetElement) && targetElement.hasKey(keyValue) && options.isMergeableElement(value)) {
       const targetValue = targetElement.get(keyValue);
-      clonedMember = cloneMemberElement(member);
+      clonedMember = cloneShallow(member);
       clonedMember.value = getMergeFunction(key, options)(targetValue, value);
     } else {
-      clonedMember = cloneMemberElement(member);
+      clonedMember = cloneShallow(member);
       clonedMember.value = cloneUnlessOtherwiseSpecified(value, options);
     }
     destination.remove(keyValue);

package/es/index.mjs

@@ -1,9 +1,3 @@
-import { has } from 'ramda';
-import { isPlainObject, isString } from 'ramda-adjunct';
-import defaultNamespaceInstance from "./namespace.mjs";
-import serializeValue from "./serializers/value/index.mjs";
-import serializeJSON from "./serializers/json.mjs";
-import serializeYAML from "./serializers/yaml-1-2.mjs";
 export { dispatchPlugins as dispatchRefractorPlugins } from "./refractor/plugins/utils/index.mjs";
 export { default as refractorPluginElementIdentity } from "./refractor/plugins/element-identity.mjs";
 export { default as refractorPluginSemanticElementIdentity } from "./refractor/plugins/semantic-element-identity.mjs";
@@ -14,59 +8,39 @@ export { ObjectElement, ArrayElement, BooleanElement, NullElement, NumberElement
 export { isElement, isStringElement, isNumberElement, isNullElement, isBooleanElement, isArrayElement, isObjectElement, isMemberElement, isLinkElement, isRefElement, isAnnotationElement, isParseResultElement, isSourceMapElement, isPrimitiveElement, hasElementSourceMap, includesSymbols, includesClasses } from "./predicates/index.mjs";
 export { default as createPredicate } from "./predicates/helpers.mjs";
 export { filter, reject, find, findAtOffset, some, traverse, parents } from "./traversal/index.mjs";
-export { visit, BREAK, mergeAllVisitors, getNodeType, keyMapDefault as keyMap } from "./traversal/visitor.mjs";
+export { visit, BREAK, mergeAllVisitors, getNodeType, cloneNode, keyMapDefault as keyMap } from "./traversal/visitor.mjs";
 export { transclude, default as Transcluder } from "./transcluder/index.mjs";
 export { dereference } from "./util.mjs";
+export { cloneShallow, cloneDeep } from "./clone/index.mjs";
+export { default as CloneError } from "./clone/errors/CloneError.mjs";
+export { default as DeepCloneError } from "./clone/errors/DeepCloneError.mjs";
+export { default as ShallowCloneError } from "./clone/errors/ShallowCloneError.mjs";
 /**
  * Transforms data to an Element from a particular namespace.
  */
-export const from = (data, namespace = defaultNamespaceInstance) => {
-  if (isString(data)) {
-    // JSON serialized refract
-    try {
-      return namespace.fromRefract(JSON.parse(data));
-    } catch {
-      // noop
-    }
-  }
-  if (isPlainObject(data) && has('element', data)) {
-    // refract javascript structure
-    return namespace.fromRefract(data);
-  }
-  return namespace.toElement(data);
-};
-
+export { default as from } from "./transformers/from.mjs";
 /**
  * Transforms the ApiDOM into JavaScript POJO.
  * This POJO would be the result of interpreting the ApiDOM
  * into JavaScript structure.
  */
-export const toValue = serializeValue;
-
+export { default as toValue } from "./transformers/serializers/value/index.mjs";
 /**
  * Transforms the ApiDOM into JSON string.
  */
-export const toJSON = serializeJSON;
-
+export { default as toJSON } from "./transformers/serializers/json.mjs";
 /**
  * Transforms the ApiDOM into YAML string.
  */
-export const toYAML = serializeYAML;
-
+export { default as toYAML } from "./transformers/serializers/yaml-1-2.mjs";
 /**
  * Creates a refract representation of an Element.
  * https://github.com/refractproject/refract-spec
  */
-export const dehydrate = (element, namespace = defaultNamespaceInstance) => {
-  return namespace.toRefract(element);
-};
-
+export { default as dehydrate } from "./transformers/dehydrate.mjs";
 /**
  * Create a refracted string representation of an Element.
  */
-export const toString = (element, namespace = defaultNamespaceInstance) => {
-  const refractStructure = dehydrate(element, namespace);
-  return JSON.stringify(refractStructure);
-};
-export { default as sexprs } from "./sexprs.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";

package/es/transformers/dehydrate.mjs

@@ -0,0 +1,9 @@
+import defaultNamespaceInstance from "../namespace.mjs";
+/**
+ * Creates a refract representation of an Element.
+ * https://github.com/refractproject/refract-spec
+ */
+const dehydrate = (element, namespace = defaultNamespaceInstance) => {
+  return namespace.toRefract(element);
+};
+export default dehydrate;

package/es/transformers/from.mjs

@@ -0,0 +1,22 @@
+import { has } from 'ramda';
+import { isPlainObject, isString } from 'ramda-adjunct';
+import defaultNamespaceInstance from "../namespace.mjs";
+/**
+ * Transforms data to an Element from a particular namespace.
+ */
+const from = (data, namespace = defaultNamespaceInstance) => {
+  if (isString(data)) {
+    // JSON serialized refract
+    try {
+      return namespace.fromRefract(JSON.parse(data));
+    } catch {
+      // noop
+    }
+  }
+  if (isPlainObject(data) && has('element', data)) {
+    // refract javascript structure
+    return namespace.fromRefract(data);
+  }
+  return namespace.toElement(data);
+};
+export default from;

package/es/{serializers → transformers/serializers}/value/index.mjs

@@ -2,6 +2,7 @@ import stampit from 'stampit';
 import { visit } from "./visitor.mjs";
 import EphemeralArray from "./ast/ephemeral-array.mjs";
 import EphemeralObject from "./ast/ephemeral-object.mjs";
+import { isElement, isBooleanElement, isNumberElement, isStringElement, isNullElement } from "../../../predicates/index.mjs";
 /* eslint-disable @typescript-eslint/naming-convention */
 const Visitor = stampit.init(function _Visitor() {
   const references = new WeakMap();
@@ -56,6 +57,12 @@ const Visitor = stampit.init(function _Visitor() {
 /* eslint-enable */
 
 const serializer = element => {
+  if (!isElement(element)) return element;
+
+  // shortcut optimization for certain element types
+  if (isStringElement(element) || isNumberElement(element) || isBooleanElement(element) || isNullElement(element)) {
+    return element.toValue();
+  }
   return visit(element, Visitor());
 };
 export default serializer;

package/es/{serializers → transformers/serializers}/value/visitor.mjs

@@ -1,5 +1,5 @@
 import { T as stubTrue } from 'ramda';
-import { visit as astVisit, keyMapDefault as baseKeyMap, getNodeType as baseGetNodeType } from "../../traversal/visitor.mjs";
+import { visit as astVisit, keyMapDefault as baseKeyMap, getNodeType as baseGetNodeType } from "../../../traversal/visitor.mjs";
 const nodeTypeGetter = node => {
   if (typeof (node === null || node === void 0 ? void 0 : node.type) === 'string') {
     return node.type;

package/es/{serializers → transformers/serializers}/yaml-1-2.mjs

@@ -1,5 +1,5 @@
 import stampit from 'stampit';
-import { visit } from "../traversal/visitor.mjs";
+import { visit } from "../../traversal/visitor.mjs";
 import serializeValue from "./value/index.mjs";
 const YamlVisitor = stampit({
   props: {

package/es/{sexprs.mjs → transformers/sexprs.mjs}

@@ -1,5 +1,5 @@
 import stampit from 'stampit';
-import { visit } from "./traversal/visitor.mjs";
+import { visit } from "../traversal/visitor.mjs";
 const SymbolicExpressionsVisitor = stampit({
   props: {
     nestingLevel: 0,

package/es/transformers/to-string.mjs

@@ -0,0 +1,10 @@
+import defaultNamespaceInstance from "../namespace.mjs";
+import dehydrate from "./dehydrate.mjs";
+/**
+ * Create a refracted string representation of an Element.
+ */
+const toString = (element, namespace = defaultNamespaceInstance) => {
+  const refractStructure = dehydrate(element, namespace);
+  return JSON.stringify(refractStructure);
+};
+export default toString;

package/es/traversal/findAtOffset.mjs

@@ -3,6 +3,7 @@ import { last, pathOr } from 'ramda';
 import { isNumber } from 'ramda-adjunct';
 import { hasElementSourceMap } from "../predicates/index.mjs";
 import { visit } from "./visitor.mjs";
+import toValue from "../transformers/serializers/value/index.mjs";
 const Visitor = stampit({
   props: {
     result: [],
@@ -25,8 +26,8 @@ const Visitor = stampit({
       }
 
       const sourceMapElement = element.getMetaProperty('sourceMap');
-      const charStart = sourceMapElement.positionStart.get(2).toValue();
-      const charEnd = sourceMapElement.positionEnd.get(2).toValue();
+      const charStart = toValue(sourceMapElement.positionStart.get(2));
+      const charEnd = toValue(sourceMapElement.positionEnd.get(2));
       const isWithinOffsetRange = this.offset >= charStart && (this.offset < charEnd || this.includeRightBound && this.offset <= charEnd);
       if (isWithinOffsetRange) {
         this.result.push(element);

package/es/traversal/visitor.mjs

@@ -1,8 +1,9 @@
 import stampit from 'stampit';
 import { F as stubFalse, pipe } from 'ramda';
 import { isString } from 'ramda-adjunct';
-import { visit as astVisit, BREAK, mergeAllVisitors } from '@swagger-api/apidom-ast';
-import { isMemberElement, isArrayElement, isStringElement, isBooleanElement, isLinkElement, isRefElement, isObjectElement, isNullElement, isNumberElement } from "../predicates/index.mjs";
+import { visit as astVisit, BREAK, mergeAllVisitors, cloneNode as cloneNodeDefault } from '@swagger-api/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 };
 
 // getNodeType :: Node -> String
@@ -19,6 +20,14 @@ export const getNodeType = element => {
   /* eslint-enable */
 };
 
+// cloneNode :: a -> a
+export const cloneNode = node => {
+  if (isElement(node)) {
+    return cloneShallow(node);
+  }
+  return cloneNodeDefault(node);
+};
+
 // isNode :: Node -> Boolean
 export const isNode = pipe(getNodeType, isString);
 export const keyMapDefault = {
@@ -81,6 +90,7 @@ visitor, {
     // @ts-ignore
     nodeTypeGetter: getNodeType,
     nodePredicate: isNode,
+    nodeCloneFn: cloneNode,
     ...rest
   });
 };
@@ -99,6 +109,7 @@ visitor, {
     // @ts-ignore
     nodeTypeGetter: getNodeType,
     nodePredicate: isNode,
+    nodeCloneFn: cloneNode,
     ...rest
   });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swagger-api/apidom-core",
-  "version": "0.76.2",
+  "version": "0.77.0",
   "description": "Tools for manipulating ApiDOM structures.",
   "publishConfig": {
     "access": "public",
@@ -42,8 +42,8 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.20.7",
-    "@swagger-api/apidom-ast": "^0.76.2",
-    "@swagger-api/apidom-error": "^0.76.2",
+    "@swagger-api/apidom-ast": "^0.77.0",
+    "@swagger-api/apidom-error": "^0.77.0",
     "@types/ramda": "~0.29.3",
     "minim": "~0.23.8",
     "ramda": "~0.29.0",
@@ -62,5 +62,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "8c6c02f813a663cfaf0ac0963f2b4fd25b8dffe8"
+  "gitHead": "cd8a9d7d2ea8bb8c335c23cd4632830a79c426c9"
 }

package/types/dist.d.ts

@@ -1,8 +1,9 @@
 /// <reference path="./minim.d.ts" />
-import { Element, ArrayElement, Meta, Attributes, Namespace as Namespace$1, NamespacePlugin, StringElement, ArraySlice, ObjectElement } from 'minim';
+import { Element, ArrayElement, Meta, Attributes, Namespace as Namespace$1, NamespacePlugin, StringElement, ArraySlice, KeyValuePair, ObjectSlice, ObjectElement } from 'minim';
 export { ArrayElement, ArraySlice, Attributes, BooleanElement, Element, KeyValuePair, LinkElement, MemberElement, Meta, NamespacePluginOptions, NullElement, NumberElement, ObjectElement, ObjectSlice, RefElement, StringElement, refract } from 'minim';
 import { Pred } from 'ramda';
 import stampit from 'stampit';
+import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
 export { BREAK, mergeAllVisitors } from '@swagger-api/apidom-ast';
 
 declare const dispatchPlugins: <T extends Element>(element: T, plugins: any[], options?: {}) => T;
@@ -146,6 +147,7 @@ declare const traverse: <T extends Element>(options: Callback | TraverseOptions,
 declare const parents: <T extends Element>(element: T) => WeakMap<Element, Element>;
 
 declare const getNodeType: <T extends Element>(element: T) => string | undefined;
+declare const cloneNode: <T>(node: T) => T;
 declare const keyMapDefault: {
     ObjectElement: string[];
     ArrayElement: string[];
@@ -200,6 +202,49 @@ declare const transclude: (search: Element, replace: Element, element: Element)
  */
 declare const dereference: (object: Record<string, any>, root?: Record<string, any>) => Record<string, any>;
 
+type FinalCloneTypes = KeyValuePair | ArraySlice | ObjectSlice;
+declare const cloneDeep: {
+    <T extends Element | FinalCloneTypes>(value: T): T;
+    safe<T_1>(value: T_1): T_1;
+};
+declare const cloneShallow: {
+    <T extends Element | FinalCloneTypes>(value: T): T;
+    safe<T_1>(value: T_1): T_1;
+};
+
+declare class CloneError extends ApiDOMStructuredError {
+}
+
+declare class DeepCloneError extends CloneError {
+}
+
+declare class ShallowCloneError extends CloneError {
+}
+
+/**
+ * Transforms data to an Element from a particular namespace.
+ */
+declare const from: (data: any, namespace?: Namespace$1) => Element;
+
+declare const serializer$2: <T extends unknown>(element: T) => any;
+
+declare const serializer$1: (element: Element, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number) => string;
+
+declare const serializer: (element: Element, { directive }?: {
+    directive?: boolean | undefined;
+}) => string;
+
+/**
+ * Creates a refract representation of an Element.
+ * https://github.com/refractproject/refract-spec
+ */
+declare const dehydrate: (element: Element, namespace?: Namespace$1) => any;
+
+/**
+ * Create a refracted string representation of an Element.
+ */
+declare const toString: (element: Element, namespace?: Namespace$1) => string;
+
 declare const sexprs: (element: Element) => string;
 
 type ObjectOrArrayElement = ObjectElement | ArrayElement;
@@ -227,34 +272,4 @@ declare namespace deepmerge {
     var all: (list: ObjectOrArrayElement[], options?: DeepMergeOptions | undefined) => any;
 }
 
-/**
- * Transforms data to an Element from a particular namespace.
- */
-declare const from: (data: any, namespace?: Namespace$1) => Element;
-/**
- * Transforms the ApiDOM into JavaScript POJO.
- * This POJO would be the result of interpreting the ApiDOM
- * into JavaScript structure.
- */
-declare const toValue: <T extends Element>(element: T) => any;
-/**
- * Transforms the ApiDOM into JSON string.
- */
-declare const toJSON: (element: Element, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined) => string;
-/**
- * Transforms the ApiDOM into YAML string.
- */
-declare const toYAML: (element: Element, { directive }?: {
-    directive?: boolean | undefined;
-}) => string;
-/**
- * Creates a refract representation of an Element.
- * https://github.com/refractproject/refract-spec
- */
-declare const dehydrate: (element: Element, namespace?: Namespace$1) => any;
-/**
- * Create a refracted string representation of an Element.
- */
-declare const toString: (element: Element, namespace?: Namespace$1) => string;
-
-export { Annotation as AnnotationElement, Comment as CommentElement, MediaTypes, Namespace, ParseResult as ParseResultElement, Position, PositionRange, SourceMap as SourceMapElement, Transcluder, createNamespace, createPredicate, deepmerge, dehydrate, dereference, dispatchPlugins as dispatchRefractorPlugins, filter, find, findAtOffset, 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, toJSON, toString, toValue, toYAML, transclude, traverse, visit };
+export { Annotation as AnnotationElement, CloneError, Comment as CommentElement, DeepCloneError, MediaTypes, Namespace, ParseResult as ParseResultElement, Position, PositionRange, ShallowCloneError, SourceMap as SourceMapElement, Transcluder, cloneDeep, cloneNode, cloneShallow, createNamespace, createPredicate, deepmerge, dehydrate, dereference, dispatchPlugins as dispatchRefractorPlugins, filter, find, findAtOffset, 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 };

package/types/minim.d.ts

@@ -214,9 +214,21 @@ declare module 'minim' {
     [Symbol.iterator](): IterableIterator<any>;
 
     toValue(): any;
+
+    clone(): ArraySlice;
+  }
+
+  export class ObjectSlice extends ArraySlice {
+    clone(): ObjectSlice;
   }
 
-  export class ObjectSlice extends ArraySlice {}
+  export class KeyValuePair {
+    public key: Element | undefined;
 
-  export class KeyValuePair {}
+    public value: Element | undefined;
+
+    constructor(key?: Element, value?: Element);
+
+    clone(): KeyValuePair;
+  }
 }