feat(evaluate): add support for ApiDOM realm (#18)

Refs #13

Author: char0n

README.md

@@ -376,7 +376,34 @@ const objectElement = new ObjectElement({
   a: ['b', 'c']
 });
 
-evaluate(objectElement, '/a/1', { realm: new MinimEvaluationRealm() }); // => 'c'
+evaluate(objectElement, '/a/1', { realm: new MinimEvaluationRealm() }); // => StringElement('c')
+```
+
+###### ApiDOM Evaluation Realm
+
+The [ApiDOM](https://github.com/swagger-api/apidom) Evaluation Realm is an integration layer that enables
+evaluation of JSON Pointer expressions on ApiDOM structures. It provides compatibility with ApiDOM [core](https://github.com/swagger-api/apidom/tree/main/packages/apidom-core) and namespace packages (`@swagger-api/apidom-ns-*`),
+allowing to traverse and query ApiDOM element instances.
+
+```js
+import { ObjectElement } from '@swagger-api/apidom-core';
+import { InfoElement } from '@swagger-api/apidom-ns-openapi-3-0'
+import { evaluate } from '@swaggerexpert/json-pointer';
+import ApiDOMEvaluationRealm from '@swaggerexpert/json-pointer/evaluate/realms/apidom';
+
+const objectElement = new ObjectElement({
+  a: ['b', 'c']
+});
+const infoElement = InfoElement.refract({
+  contact: {
+    name: 'SwaggerExpert',
+    email: 'contact@swaggerexpert.com'
+  }
+})
+
+
+evaluate(objectElement, '/a/1', { realm: new ApiDOMEvaluationRealm() }); // => StringElement('c')
+evaluate(infoElement, '/contact/name', { realm: new ApiDOMEvaluationRealm() }); // => StringElement('SwaggerExpert')
 ```
 
 ###### Custom Evaluation Realms

package-lock.json

@@ -77,6 +77,8 @@
     "@babel/preset-env": "=7.26.9",
     "@commitlint/cli": "=19.8.0",
     "@commitlint/config-conventional": "=19.8.0",
+    "@swagger-api/apidom-core": "^1.0.0-beta.30",
+    "@swagger-api/apidom-ns-openapi-3-0": "^1.0.0-beta.30",
     "apg-js": "^4.4.0",
     "babel-plugin-module-resolver": "^5.0.2",
     "chai": "=5.2.0",

package.json

@@ -0,0 +1,52 @@
+import { isObjectElement, isArrayElement } from '@swagger-api/apidom-core';
+
+import EvaluationRealm from '../EvaluationRealm.js';
+import JSONPointerKeyError from '../../errors/JSONPointerKeyError.js';
+
+class ApiDOMEvaluationRealm extends EvaluationRealm {
+  name = 'apidom';
+
+  isArray(node) {
+    return isArrayElement(node);
+  }
+
+  isObject(node) {
+    return isObjectElement(node);
+  }
+
+  sizeOf(node) {
+    if (this.isArray(node) || this.isObject(node)) {
+      return node.length;
+    }
+    return 0;
+  }
+
+  has(node, referenceToken) {
+    if (this.isArray(node)) {
+      return Number(referenceToken) < this.sizeOf(node);
+    }
+    if (this.isObject(node)) {
+      const keys = node.keys();
+      const uniqueKeys = new Set(keys);
+
+      if (keys.length !== uniqueKeys.size) {
+        throw new JSONPointerKeyError(`Object keys must be unique for '${referenceToken}'`, {
+          currentValue: node,
+          referenceToken,
+        });
+      }
+
+      return node.hasKey(referenceToken);
+    }
+    return false;
+  }
+
+  evaluate(node, referenceToken) {
+    if (this.isArray(node)) {
+      return node.get(Number(referenceToken));
+    }
+    return node.get(referenceToken);
+  }
+}
+
+export default ApiDOMEvaluationRealm;