Add location the JSON nodes

Author: jdesrosiers

package.json

@@ -45,6 +45,7 @@
     "vitest": "*"
   },
   "dependencies": {
+    "@hyperjump/json-pointer": "^1.1.1",
     "@hyperjump/uri": "^1.3.0",
     "content-type": "^1.0.5",
     "moo": "^0.5.2",

src/hyperjump/hyperjump.d.ts

@@ -1,5 +1,5 @@
 import type { JsonNode } from "../json/jsonast.d.ts";
-import type { JrefNode } from "../jref/jref-ast.d.ts";
+import type { JrefNode, JrefJrefNode } from "../jref/jref-ast.d.ts";
 import type { UriSchemePlugin } from "./uri-schemes/uri-scheme-plugin.d.ts";
 import type { DocumentNode, MediaTypePlugin } from "./media-types/media-type-plugin.d.ts";
 import type { jsonObjectHas, jsonObjectKeys, jsonValue } from "../json/jsonast-util.js";
@@ -11,7 +11,8 @@ export type GetOptions = {
   referencedFrom?: string;
 };
 
-export class Hyperjump<T extends JrefNode = JrefNode> {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export class Hyperjump<T extends JrefNode<any> = JrefJrefNode> {
   constructor(config?: HyperjumpConfig);
 
   /**
@@ -29,7 +30,7 @@ export class Hyperjump<T extends JrefNode = JrefNode> {
    * @throws {@link RetrievalError}
    * @throws {@link json.JsonPointerError}
    */
-  get: (uri: string, options?: GetOptions) => Promise<JsonNode<T>>;
+  get: (uri: string, options?: GetOptions) => Promise<T & JsonNode<T>>;
 
   /**
    * Add support for a
@@ -93,27 +94,27 @@ export class Hyperjump<T extends JrefNode = JrefNode> {
    * This is like indexing into an object or array. It will follow any
    * references it encounters so it always returns a JSON compatible value.
    */
-  step: (key: string, node: JsonNode<T>) => Promise<JsonNode<T>>;
+  step: (key: string, node: JsonNode<T>) => Promise<T & JsonNode<T>>;
 
   /**
    * Iterate over an array node. It will follow any references it encounters so
    * it always yields JSON compatible values.
    */
-  iter: (node: JsonNode<T>) => AsyncGenerator<JsonNode<T>, void, unknown>;
+  iter: (node: JsonNode<T>) => AsyncGenerator<T & JsonNode<T>, void, unknown>;
 
   keys: typeof jsonObjectKeys;
 
   /**
    * Iterate over the values of an object. It will follow any references it
    * encounters so it always yields JSON compatible values.
    */
-  values: (node: JsonNode<T>) => AsyncGenerator<JsonNode<T>, void, unknown>;
+  values: (node: JsonNode<T>) => AsyncGenerator<T & JsonNode<T>, void, unknown>;
 
   /**
    * Iterate over key/value pairs of an object. It will follow any references it
    * encounters so it always yields JSON compatible values.
    */
-  entries: (node: JsonNode<T>) => AsyncGenerator<[string, JsonNode<T>], void, unknown>;
+  entries: (node: JsonNode<T>) => AsyncGenerator<[string, T & JsonNode<T>], void, unknown>;
 }
 
 export class RetrievalError extends Error {

src/hyperjump/hyperjump.js

@@ -99,7 +99,7 @@ export class Hyperjump {
   /** @type (node: T) => Promise<JsonNode<T>> */
   async #followReferences(node) {
     if ("jrefType" in node) {
-      return this.get(node.href, { referencedFrom: node.documentUri });
+      return this.get(node.href, { referencedFrom: toAbsoluteIri(node.location) });
     } else {
       return /** @type JsonNode<T> */ (node);
     }

src/jref/jref-ast.d.ts

@@ -13,7 +13,6 @@ import {
 export interface JrefReferenceNode {
   jrefType: "jref-reference";
   href: string;
-  documentUri: string;
 };
 
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions

src/jref/jref-util.js

@@ -37,14 +37,13 @@ const defaultReviver = (value) => value;
  * @type API.fromJref
  */
 export const fromJref = (jref, uri, reviver = defaultReviver) => {
-  return fromJson(jref, (node, key) => {
+  return fromJson(jref, uri, (node, key) => {
     const jrefNode = /** @type JsonNode<JrefJrefNode> */ (node);
 
     const returned = { uri: "" };
     if (isReference(jrefNode, returned)) {
       jrefNode.jrefType = "jref-reference";
       jrefNode.href = resolveIri(returned.uri, uri);
-      jrefNode.documentUri = uri;
     }
 
     node.type = "jref";