@swagger-api/apidom-core 0.82.2 → 0.83.0

package/es/clone/errors/CloneError.mjs

@@ -3,7 +3,7 @@ class CloneError extends ApiDOMStructuredError {
   constructor(message, structuredOptions) {
     super(message, structuredOptions);
     if (typeof structuredOptions !== 'undefined') {
-      this.value = structuredOptions.source;
+      this.value = structuredOptions.value;
     }
   }
 }

package/es/identity/errors/ElementIdentityError.mjs

@@ -0,0 +1,10 @@
+import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
+class ElementIdentityError extends ApiDOMStructuredError {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.value = structuredOptions.value;
+    }
+  }
+}
+export default ElementIdentityError;

package/es/identity/index.mjs

@@ -0,0 +1,58 @@
+import { StringElement } from 'minim';
+import stampit from 'stampit';
+import ShortUniqueId from 'short-unique-id';
+import ElementIdentityError from "./errors/ElementIdentityError.mjs";
+import { isElement, isStringElement } from "../predicates/index.mjs";
+export const IdentityManager = stampit({
+  props: {
+    uuid: null,
+    length: null,
+    identityMap: null
+  },
+  init({
+    length = 6
+  } = {}) {
+    this.length = 6;
+    this.uuid = new ShortUniqueId({
+      length
+    });
+    this.identityMap = new WeakMap();
+  },
+  methods: {
+    identify(element) {
+      if (!isElement(element)) {
+        throw new ElementIdentityError('Cannot not identify the element. `element` is neither structurally compatible nor a subclass of an Element class.', {
+          value: element
+        });
+      }
+
+      // use already assigned identity
+      if (element.meta.hasKey('id') && isStringElement(element.meta.id) && !element.meta.id.equals('')) {
+        return element.id;
+      }
+
+      // assign identity in immutable way
+      if (this.identityMap.has(element)) {
+        return this.identityMap.get(element);
+      }
+
+      // return element identity
+      const id = new StringElement(this.generateId());
+      this.identityMap.set(element, id);
+      return id;
+    },
+    forget(element) {
+      if (this.identityMap.has(element)) {
+        this.identityMap.delete(element);
+        return true;
+      }
+      return false;
+    },
+    generateId() {
+      return this.uuid.randomUUID();
+    }
+  }
+});
+export const defaultIdentityManager = IdentityManager({
+  length: 6
+});

package/es/index.mjs

@@ -15,6 +15,8 @@ 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";
+export { defaultIdentityManager, IdentityManager } from "./identity/index.mjs";
+export { default as ElementIdentityError } from "./identity/errors/ElementIdentityError.mjs";
 /**
  * Transforms data to an Element from a particular namespace.
  */

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

@@ -1,28 +1,26 @@
-import ShortUniqueId from 'short-unique-id';
 import { StringElement } from 'minim';
-
+import { IdentityManager } from "../../identity/index.mjs";
 /**
  * Plugin for decorating every element in ApiDOM tree with UUID.
  */
-
 const plugin = ({
   length = 6
 } = {}) => () => {
-  let uuid;
+  let identityManager;
   return {
     pre() {
-      uuid = new ShortUniqueId({
+      identityManager = IdentityManager({
         length
       });
     },
     visitor: {
       enter(element) {
-        // eslint-disable-next-line no-param-reassign
-        element.id = new StringElement(uuid.randomUUID());
+        element.id = new StringElement(identityManager.generateId()); // eslint-disable-line no-param-reassign
       }
     },
+
     post() {
-      uuid = null;
+      identityManager = null;
     }
   };
 };

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

@@ -1,32 +1,30 @@
-import ShortUniqueId from 'short-unique-id';
 import { StringElement } from 'minim';
-
+import { IdentityManager } from "../../identity/index.mjs";
 /**
  * Plugin for decorating every semantic element in ApiDOM tree with UUID.
  */
-
 const plugin = ({
   length = 6
 } = {}) => ({
   predicates
 }) => {
-  let uuid;
+  let identityManager;
   return {
     pre() {
-      uuid = new ShortUniqueId({
+      identityManager = IdentityManager({
         length
       });
     },
     visitor: {
       enter(element) {
         if (!predicates.isPrimitiveElement(element)) {
-          // eslint-disable-next-line no-param-reassign
-          element.id = new StringElement(uuid.randomUUID());
+          element.id = new StringElement(identityManager.generateId()); // eslint-disable-line no-param-reassign
         }
       }
     },
+
     post() {
-      uuid = null;
+      identityManager = null;
     }
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swagger-api/apidom-core",
-  "version": "0.82.2",
+  "version": "0.83.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.82.2",
-    "@swagger-api/apidom-error": "^0.82.1",
+    "@swagger-api/apidom-ast": "^0.83.0",
+    "@swagger-api/apidom-error": "^0.83.0",
     "@types/ramda": "~0.29.6",
     "minim": "~0.23.8",
     "ramda": "~0.29.0",
@@ -62,5 +62,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "4d2a5697cba7abcab32abfdbea6ba946b4fd262f"
+  "gitHead": "4f5563541b7973162e0d5096966d56dbad4c706c"
 }

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, NumberElement, NullElement, BooleanElement, ObjectElement, MemberElement, LinkElement, RefElement, KeyValuePair, ObjectSlice } 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 stampit from 'stampit';
 import { ApiDOMStructuredError, ApiDOMErrorOptions } from '@swagger-api/apidom-error';
+import ShortUniqueId from 'short-unique-id';
 export { BREAK, mergeAllVisitors } from '@swagger-api/apidom-ast';
 
 declare const dispatchPlugins: <T extends Element>(element: T, plugins: any[], options?: {}) => T;
@@ -20,53 +21,6 @@ declare const plugin$1: ({ length }?: {
     post(): void;
 };
 
-/**
- * Plugin for decorating every semantic element in ApiDOM tree with UUID.
- */
-type Predicates = {
-    isPrimitiveElement: (element: Element) => boolean;
-};
-declare const plugin: ({ length }?: {
-    length?: number | undefined;
-}) => ({ predicates }: {
-    predicates: Predicates;
-}) => {
-    pre(): void;
-    visitor: {
-        enter<T extends Element>(element: T): void;
-    };
-    post(): void;
-};
-
-declare class MediaTypes<T> extends Array<T> {
-    unknownMediaType: string;
-    filterByFormat(): void;
-    findBy(): void;
-    latest(): void;
-}
-
-interface Position {
-    row: number;
-    column: number;
-    char: number;
-}
-interface PositionRange {
-    start: Position;
-    end: Position;
-}
-declare class SourceMap extends ArrayElement {
-    constructor(content?: Array<any>, meta?: Meta, attributes?: Attributes);
-    get positionStart(): Element | undefined;
-    get positionEnd(): Element | undefined;
-    set position(position: PositionRange | null);
-}
-
-declare class Namespace extends Namespace$1 {
-    constructor();
-}
-declare const namespace: Namespace;
-declare const createNamespace: (namespacePlugin?: NamespacePlugin) => Namespace;
-
 declare class Annotation extends StringElement {
     constructor(content?: string, meta?: Meta, attributes?: Attributes);
     get code(): any;
@@ -89,6 +43,22 @@ declare class ParseResult extends ArrayElement {
     replaceResult(replacement: Element): boolean;
 }
 
+interface Position {
+    row: number;
+    column: number;
+    char: number;
+}
+interface PositionRange {
+    start: Position;
+    end: Position;
+}
+declare class SourceMap extends ArrayElement {
+    constructor(content?: Array<any>, meta?: Meta, attributes?: Attributes);
+    get positionStart(): Element | undefined;
+    get positionEnd(): Element | undefined;
+    set position(position: PositionRange | null);
+}
+
 interface PredicateHelpers {
     hasMethod: typeof hasMethod;
     hasBasicElementProps: typeof hasBasicElementProps;
@@ -137,6 +107,37 @@ declare const hasElementSourceMap: <T extends Element>(element: T) => boolean;
 declare const includesSymbols: <T extends Element>(symbols: string[], element: T) => boolean;
 declare const includesClasses: <T extends Element>(classes: string[], element: T) => boolean;
 
+/**
+ * Plugin for decorating every semantic element in ApiDOM tree with UUID.
+ */
+type Predicates = {
+    isPrimitiveElement: typeof isPrimitiveElement;
+};
+declare const plugin: ({ length }?: {
+    length?: number | undefined;
+}) => ({ predicates }: {
+    predicates: Predicates;
+}) => {
+    pre(): void;
+    visitor: {
+        enter<T extends Element>(element: T): void;
+    };
+    post(): void;
+};
+
+declare class MediaTypes<T> extends Array<T> {
+    unknownMediaType: string;
+    filterByFormat(): void;
+    findBy(): void;
+    latest(): void;
+}
+
+declare class Namespace extends Namespace$1 {
+    constructor();
+}
+declare const namespace: Namespace;
+declare const createNamespace: (namespacePlugin?: NamespacePlugin) => Namespace;
+
 declare const filter: <T extends Element>(predicate: (element: any) => boolean, element: T) => ArraySlice;
 
 declare const find: <T extends Element>(predicate: (element: any) => boolean, element: T) => T | undefined;
@@ -243,6 +244,25 @@ declare class DeepCloneError extends CloneError {
 declare class ShallowCloneError extends CloneError {
 }
 
+interface IdentityManager<T extends Element = Element> {
+    length: number;
+    uuid: ShortUniqueId;
+    identityMap: WeakMap<T, StringElement>;
+    identify(this: IdentityManager<T>, element: T): StringElement;
+    forget(this: IdentityManager<T>, element: T): boolean;
+    generateId(this: IdentityManager<T>): string;
+}
+declare const IdentityManager: stampit.Stamp<IdentityManager>;
+declare const defaultIdentityManager: IdentityManager<Element>;
+
+interface ElementIdentityErrorOptions extends ApiDOMErrorOptions {
+    readonly value: unknown;
+}
+declare class ElementIdentityError extends ApiDOMStructuredError {
+    readonly value: unknown;
+    constructor(message?: string, structuredOptions?: ElementIdentityErrorOptions);
+}
+
 /**
  * Transforms data to an Element from a particular namespace.
  */
@@ -294,4 +314,4 @@ declare namespace deepmerge {
     var all: (list: ObjectOrArrayElement[], options?: DeepMergeOptions | undefined) => any;
 }
 
-export { Annotation as AnnotationElement, CloneError, Comment as CommentElement, DeepCloneError, type ElementPredicate, MediaTypes, Namespace, ParseResult as ParseResultElement, type Position, type 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 };
+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, 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 };