Type cleanup

Author: jdesrosiers

src/jref/jref-util.d.ts

@@ -1,13 +1,13 @@
 import { JrefCompatible, JrefNode } from "./jref-ast.d.ts";
 
 
-export type Reviver<A extends JrefNode | undefined> = (node: JrefCompatible<NonNullable<A>>, key?: string) => A;
+export type Reviver<A = JrefNode> = (node: JrefCompatible<NonNullable<A>>, key?: string) => A;
 
 /**
  * Parse a JRef string into a JRef AST. Includes a reviver option similar to
  * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse | JSON.parse}.
  */
-export const fromJref: <A extends JrefNode | undefined = JrefNode>(jref: string, uri: string, reviver?: Reviver<A>) => A;
+export const fromJref: <A = JrefNode>(jref: string, uri: string, reviver?: Reviver<A>) => A;
 
 export type Replacer = (value: JrefNode, key?: string) => JrefNode | undefined;
 

src/jref/jref-util.js

@@ -7,8 +7,8 @@ import {
 } from "../json/jsonast-util.js";
 
 /**
- * @import { JsonObjectNode } from "../json/jsonast.js"
- * @import { JrefNode } from "./jref-ast.js"
+ * @import { JsonNode, JsonObjectNode } from "../json/jsonast.d.ts"
+ * @import { JrefNode } from "./jref-ast.d.ts"
  * @import * as API from "./jref-util.d.ts"
  */
 
@@ -35,11 +35,16 @@ export const fromJref = (jref, uri, reviver = defaultReviver) => {
   });
 };
 
-/** @type <A extends JrefNode>(node: JsonObjectNode<A>) => string | undefined */
+/** @type <A>(node: JsonObjectNode<A>) => string | undefined */
 const isReference = (objectNode) => {
   for (const propertyNode of objectNode.children) {
     if (propertyNode.children[0].value === "$ref") {
-      const valueNode = propertyNode.children[1];
+      const unknownValueNode = propertyNode.children[1];
+      if (!unknownValueNode || typeof unknownValueNode !== "object") {
+        continue;
+      }
+      /** @type JsonNode */
+      const valueNode = /** @type any */ (unknownValueNode);
       if (valueNode.type === "json" && valueNode.jsonType === "string") {
         return valueNode.value;
       }

src/jref/jref-util.test.js

@@ -3,7 +3,8 @@ import { fromJref, toJref } from "./jref-util.js";
 import { resolveIri } from "@hyperjump/uri";
 
 /**
- * @import { JrefNode } from "../jref/jref-ast.js"
+ * @import { JrefNode } from "./jref-ast.d.ts"
+ * @import { Reviver } from "./jref-util.d.ts"
  */
 
 
@@ -275,7 +276,8 @@ describe("JRef", () => {
 
     describe("reviver", () => {
       test("convert properties that start with 'i' to integers", () => {
-        const subject = fromJref(`{ "foo": 42, "iBar": "42", "baz": { "$ref": "./foo" } }`, testContext, (node, key) => {
+        /** @type Reviver<JrefNode> */
+        const reviver = (node, key) => {
           if (key?.startsWith("i") && node.type === "json" && node.jsonType === "string") {
             return {
               ...node,
@@ -285,7 +287,8 @@ describe("JRef", () => {
           } else {
             return node;
           }
-        });
+        };
+        const subject = fromJref(`{ "foo": 42, "iBar": "42", "baz": { "$ref": "./foo" } }`, testContext, reviver);
         expect(toJref(subject, testContext)).to.equal(`{"foo":42,"iBar":42,"baz":{"$ref":"foo"}}`);
       });
     });

src/json/jsonast-util.d.ts

@@ -10,7 +10,7 @@ import {
   JsonStringNode
 } from "./jsonast.d.ts";
 
-export type Reviver<A> = (node: JsonCompatible<NonNullable<A>>, key?: string) => A;
+export type Reviver<A = JsonNode> = (node: JsonCompatible<NonNullable<A>>, key?: string) => A;
 
 /**
  * Parse a JSON string into a JSON AST. Includes a reviver option similar to

src/json/jsonast-util.js

@@ -7,7 +7,6 @@ import { JsonLexer } from "./json-lexer.js";
  *   JsonArrayNode,
  *   JsonBooleanNode,
  *   JsonCompatible,
- *   JsonNode,
  *   JsonNullNode,
  *   JsonNumberNode,
  *   JsonObjectNode,
@@ -244,12 +243,7 @@ export const fromJs = (js) => {
   }
 };
 
-/**
- * @template [A = JsonNode]
- * @typedef {(node: A, key?: string) => JsonCompatible<A> | undefined} Replacer
- */
-
-/** @type Replacer<any> */
+/** @type API.Replacer<any> */
 const defaultReplacer = (node) => node; // eslint-disable-line @typescript-eslint/no-unsafe-return
 
 /** @type API.toJson */
@@ -258,7 +252,7 @@ export const toJson = (node, replacer = defaultReplacer, space = "") => {
   return replacedNode ? stringifyValue(replacedNode, replacer, space, 1) : "";
 };
 
-/** @type <A>(node: JsonCompatible<A>, replacer: Replacer<A>, space: string, depth: number) => string */
+/** @type <A>(node: JsonCompatible<A>, replacer: API.Replacer<A>, space: string, depth: number) => string */
 const stringifyValue = (node, replacer, space, depth) => {
   switch (node.jsonType) {
     case "array":
@@ -270,7 +264,7 @@ const stringifyValue = (node, replacer, space, depth) => {
   }
 };
 
-/** @type <A>(node: JsonArrayNode<A>, replacer: Replacer<A>, space: string, depth: number) => string */
+/** @type <A>(node: JsonArrayNode<A>, replacer: API.Replacer<A>, space: string, depth: number) => string */
 const stringifyArray = (node, replacer, space, depth) => {
   if (node.children.length === 0) {
     return "[]";
@@ -292,7 +286,7 @@ const stringifyArray = (node, replacer, space, depth) => {
   return result + padding + "]";
 };
 
-/** @type <A>(node: JsonObjectNode<A>, replacer: Replacer<A>, space: string, depth: number) => string */
+/** @type <A>(node: JsonObjectNode<A>, replacer: API.Replacer<A>, space: string, depth: number) => string */
 const stringifyObject = (node, replacer, space, depth) => {
   if (node.children.length === 0) {
     return "{}";

src/json/jsonast.d.ts

@@ -78,7 +78,12 @@ export type JsonNode = JsonObjectNode
   | JsonBooleanNode
   | JsonNullNode;
 
-export type JsonCompatible<A> = JsonObjectNode<A> | JsonArrayNode<A> | JsonStringNode | JsonNumberNode | JsonBooleanNode | JsonNullNode;
+export type JsonCompatible<A> = JsonObjectNode<A>
+  | JsonArrayNode<A>
+  | JsonStringNode
+  | JsonNumberNode
+  | JsonBooleanNode
+  | JsonNullNode;
 
 export type JsonType = "null" | "boolean" | "number" | "string" | "array" | "object";