feat(core): change from stamps to TypeScript classes (#4095)

Refs #3481

BREAKING CHANGE: IdentityManager from apidom-core package became a class and requires to be instantiated with new operator.

Author: char0n

package-lock.json

@@ -49,7 +49,7 @@
     "ramda": "~0.30.0",
     "ramda-adjunct": "^5.0.0",
     "short-unique-id": "^5.0.2",
-    "stampit": "^4.3.2"
+    "ts-mixer": "^6.0.3"
   },
   "files": [
     "cjs/",

packages/apidom-core/package.json

@@ -1,75 +1,60 @@
 import { Element, StringElement } from 'minim';
-import stampit from 'stampit';
 import ShortUniqueId from 'short-unique-id';
 
 import ElementIdentityError from './errors/ElementIdentityError';
 import { isElement, isStringElement } from '../predicates';
 
-export interface IdentityManager<T extends Element = Element> {
-  length: number;
-  uuid: ShortUniqueId;
-  identityMap: WeakMap<T, StringElement>;
+export class IdentityManager {
+  protected readonly uuid: ShortUniqueId;
 
-  identify(this: IdentityManager<T>, element: T): StringElement;
-  forget(this: IdentityManager<T>, element: T): boolean;
-  generateId(this: IdentityManager<T>): string;
-}
+  protected readonly identityMap: WeakMap<Element, StringElement>;
 
-// @TODO([email protected]): transforming this stamp to class will break backward compatibility
-export const IdentityManager: stampit.Stamp<IdentityManager> = stampit({
-  props: {
-    uuid: null,
-    length: null,
-    identityMap: null,
-  },
-  init(this: IdentityManager, { length = 6 } = {}) {
-    this.length = 6;
+  constructor({ length = 6 } = {}) {
     this.uuid = new ShortUniqueId({ length });
     this.identityMap = new WeakMap();
-  },
-  methods: {
-    identify<T extends Element>(this: IdentityManager, element: T): StringElement {
-      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.get('id')) &&
-        !element.meta.get('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<T extends Element>(this: IdentityManager, element: T): boolean {
-      if (this.identityMap.has(element)) {
-        this.identityMap.delete(element);
-        return true;
-      }
-      return false;
-    },
-
-    generateId(this: IdentityManager): string {
-      return this.uuid.randomUUID();
-    },
-  },
-});
+  }
+
+  identify<T extends Element>(this: IdentityManager, element: T): StringElement {
+    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.get('id')) &&
+      !element.meta.get('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<T extends Element>(element: T): boolean {
+    if (this.identityMap.has(element)) {
+      this.identityMap.delete(element);
+      return true;
+    }
+    return false;
+  }
+
+  generateId() {
+    return this.uuid.randomUUID();
+  }
+}
 
-export const defaultIdentityManager = IdentityManager({ length: 6 });
+export const defaultIdentityManager = new IdentityManager();

packages/apidom-core/src/identity/index.ts

@@ -13,7 +13,7 @@ const plugin =
 
     return {
       pre() {
-        identityManager = IdentityManager({ length });
+        identityManager = new IdentityManager({ length });
       },
       visitor: {
         enter<T extends Element>(element: T) {

packages/apidom-core/src/refractor/plugins/element-identity.ts

@@ -18,7 +18,7 @@ const plugin =
 
     return {
       pre() {
-        identityManager = IdentityManager({ length });
+        identityManager = new IdentityManager({ length });
       },
       visitor: {
         enter<T extends Element>(element: T) {

packages/apidom-core/src/refractor/plugins/semantic-element-identity.ts

@@ -39,7 +39,7 @@ import Reference from '../../../Reference';
 const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
 
 // initialize element identity manager
-const identityManager = IdentityManager();
+const identityManager = new IdentityManager();
 
 const AsyncApi2DereferenceVisitor = stampit({
   props: {

packages/apidom-reference/src/dereference/strategies/asyncapi-2/visitor.ts

@@ -40,7 +40,7 @@ import Reference from '../../../Reference';
 const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
 
 // initialize element identity manager
-const identityManager = IdentityManager();
+const identityManager = new IdentityManager();
 
 const OpenApi2DereferenceVisitor = stampit({
   props: {

packages/apidom-reference/src/dereference/strategies/openapi-2/visitor.ts

@@ -43,7 +43,7 @@ import { AncestorLineage } from '../../util';
 const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
 
 // initialize element identity manager
-const identityManager = IdentityManager();
+const identityManager = new IdentityManager();
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const OpenApi3_0DereferenceVisitor = stampit({

packages/apidom-reference/src/dereference/strategies/openapi-3-0/visitor.ts

@@ -53,7 +53,7 @@ import EvaluationJsonSchemaUriError from '../../../errors/EvaluationJsonSchemaUr
 const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
 
 // initialize element identity manager
-const identityManager = IdentityManager();
+const identityManager = new IdentityManager();
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const OpenApi3_1DereferenceVisitor = stampit({