Skip to content

Commit 3925e70

Browse files
jdesrosiersjdesrosiers
committed
Make Hyperjump generic
1 parent 1bb02d7 commit 3925e70

File tree

11 files changed

+39
-38
lines changed

11 files changed

+39
-38
lines changed

‎src/hyperjump/hyperjump.d.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export type GetOptions = {
1111
referencedFrom?: string;
1212
};
1313

14-
export class Hyperjump {
14+
export class Hyperjump<T extends JrefNode = JrefNode> {
1515
constructor(config?: HyperjumpConfig);
1616

1717
/**
@@ -29,7 +29,7 @@ export class Hyperjump {
2929
* @throws {@link RetrievalError}
3030
* @throws {@link json.JsonPointerError}
3131
*/
32-
get: (uri: string, options?: GetOptions) => Promise<JsonCompatible<JrefNode>>;
32+
get: (uri: string, options?: GetOptions) => Promise<JsonCompatible<T>>;
3333

3434
/**
3535
* Add support for a
@@ -94,27 +94,27 @@ export class Hyperjump {
9494
* This is like indexing into an object or array. It will follow any
9595
* references it encounters so it always returns a JSON compatible value.
9696
*/
97-
step: (key: string, node: JsonCompatible<JrefNode>) => Promise<JsonCompatible<JrefNode>>;
97+
step: (key: string, node: JsonCompatible<T>) => Promise<JsonCompatible<T>>;
9898

9999
/**
100100
* Iterate over an array node. It will follow any references it encounters so
101101
* it always yields JSON compatible values.
102102
*/
103-
iter: (node: JsonCompatible<JrefNode>) => AsyncGenerator<JsonCompatible<JrefNode>, void, unknown>;
103+
iter: (node: JsonCompatible<T>) => AsyncGenerator<JsonCompatible<T>, void, unknown>;
104104

105105
keys: typeof jsonObjectKeys;
106106

107107
/**
108108
* Iterate over the values of an object. It will follow any references it
109109
* encounters so it always yields JSON compatible values.
110110
*/
111-
values: (node: JsonCompatible<JrefNode>) => AsyncGenerator<JsonCompatible<JrefNode>, void, unknown>;
111+
values: (node: JsonCompatible<T>) => AsyncGenerator<JsonCompatible<T>, void, unknown>;
112112

113113
/**
114114
* Iterate over key/value pairs of an object. It will follow any references it
115115
* encounters so it always yields JSON compatible values.
116116
*/
117-
entries: (node: JsonCompatible<JrefNode>) => AsyncGenerator<[string, JsonCompatible<JrefNode>], void, unknown>;
117+
entries: (node: JsonCompatible<T>) => AsyncGenerator<[string, JsonCompatible<T>], void, unknown>;
118118
}
119119

120120
export class RetrievalError extends Error {

‎src/hyperjump/hyperjump.js‎

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ import { mimeMatch } from "./utilities.js";
2121
// TODO: Support fetch options in get
2222
// TODO: Support filters
2323

24+
/**
25+
* @template {JrefNode} [T=JrefNode]
26+
* @implements API.Hyperjump<T>
27+
*/
2428
export class Hyperjump {
2529
// TODO: Add config to enable schemes and media types
2630
#config;
@@ -59,7 +63,7 @@ export class Hyperjump {
5963
this.addMediaTypePlugin(new JsonMediaTypePlugin());
6064
}
6165

62-
/** @type API.Hyperjump["get"] */
66+
/** @type API.Hyperjump<T>["get"] */
6367
async get(uri, options = this.#defaultGetOptions) {
6468
uri = resolveIri(uri, contextUri());
6569
const id = toAbsoluteIri(uri);
@@ -89,32 +93,32 @@ export class Hyperjump {
8993
const cursor = document.fragmentKind === "json-pointer" ? fragment : "";
9094

9195
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
92-
const node = pointerGet(cursor ?? "", document.children[0], document.uri);
96+
const node = /** @type T */ (pointerGet(cursor ?? "", document.children[0], document.uri));
9397
return await this.#followReferences(node);
9498
}
9599

96-
/** @type (node: JrefNode) => Promise<JsonCompatible<JrefNode>> */
100+
/** @type (node: T) => Promise<JsonCompatible<T>> */
97101
async #followReferences(node) {
98102
if (node?.type === "jref-reference") {
99103
return this.get(node.value, { referencedFrom: node.documentUri });
100104
} else {
101-
return node;
105+
return /** @type JsonCompatible<T> */ (node);
102106
}
103107
}
104108

105-
/** @type API.Hyperjump["addUriSchemePlugin"] */
109+
/** @type API.Hyperjump<T>["addUriSchemePlugin"] */
106110
addUriSchemePlugin(plugin) {
107111
for (const scheme of plugin.schemes) {
108112
this.#uriSchemePlugins[scheme] = plugin;
109113
}
110114
}
111115

112-
/** @type API.Hyperjump["removeUriSchemePlugin"] */
116+
/** @type API.Hyperjump<T>["removeUriSchemePlugin"] */
113117
removeUriSchemePlugin(scheme) {
114118
delete this.#uriSchemePlugins[scheme];
115119
}
116120

117-
/** @type API.Hyperjump["retrieve"] */
121+
/** @type API.Hyperjump<T>["retrieve"] */
118122
async retrieve(uri, options) {
119123
const { scheme } = parseIri(uri);
120124

@@ -125,7 +129,7 @@ export class Hyperjump {
125129
return this.#uriSchemePlugins[scheme].retrieve(uri, options);
126130
}
127131

128-
/** @type API.Hyperjump["acceptableMediaTypes"] */
132+
/** @type API.Hyperjump<T>["acceptableMediaTypes"] */
129133
acceptableMediaTypes() {
130134
let accept = "";
131135

@@ -149,7 +153,7 @@ export class Hyperjump {
149153
return accept;
150154
}
151155

152-
/** @type API.Hyperjump["getMediaType"] */
156+
/** @type API.Hyperjump<T>["getMediaType"] */
153157
getMediaType(uri) {
154158
for (const contentType in this.#mediaTypePlugins) {
155159
for (const extension of this.#mediaTypePlugins[contentType].extensions) {
@@ -164,17 +168,17 @@ export class Hyperjump {
164168
throw new UnknownMediaTypeError(`The media type of the file at '${uri}' could not be determined. Use the 'addMediaTypePlugin' function to add support for this media type.`);
165169
}
166170

167-
/** @type API.Hyperjump["addMediaTypePlugin"] */
171+
/** @type API.Hyperjump<T>["addMediaTypePlugin"] */
168172
addMediaTypePlugin(plugin) {
169173
this.#mediaTypePlugins[plugin.mediaType] = plugin;
170174
}
171175

172-
/** @type API.Hyperjump["removeMediaTypePlugin"] */
176+
/** @type API.Hyperjump<T>["removeMediaTypePlugin"] */
173177
removeMediaTypePlugin(contentType) {
174178
delete this.#mediaTypePlugins[contentType];
175179
}
176180

177-
/** @type API.Hyperjump["setMediaTypeQuality"] */
181+
/** @type API.Hyperjump<T>["setMediaTypeQuality"] */
178182
setMediaTypeQuality(contentType, quality) {
179183
this.#mediaTypePlugins[contentType].quality = quality;
180184
}
@@ -200,12 +204,12 @@ export class Hyperjump {
200204
typeOf = jsonTypeOf;
201205
has = jsonObjectHas;
202206

203-
/** @type API.Hyperjump["step"] */
207+
/** @type API.Hyperjump<T>["step"] */
204208
async step(key, node) {
205-
return await this.#followReferences(pointerStep(key, node));
209+
return await this.#followReferences(/** @type T */ (pointerStep(key, node)));
206210
}
207211

208-
/** @type API.Hyperjump["iter"] */
212+
/** @type API.Hyperjump<T>["iter"] */
209213
async* iter(node) {
210214
if (node.jsonType === "array") {
211215
for (const itemNode of node.children) {
@@ -216,7 +220,7 @@ export class Hyperjump {
216220

217221
keys = jsonObjectKeys;
218222

219-
/** @type API.Hyperjump["values"] */
223+
/** @type API.Hyperjump<T>["values"] */
220224
async* values(node) {
221225
if (node.jsonType === "object") {
222226
for (const propertyNode of node.children) {
@@ -225,11 +229,14 @@ export class Hyperjump {
225229
}
226230
}
227231

228-
/** @type API.Hyperjump["entries"] */
232+
/** @type API.Hyperjump<T>["entries"] */
229233
async* entries(node) {
230234
if (node.jsonType === "object") {
231235
for (const propertyNode of node.children) {
232-
yield [propertyNode.children[0].value, await this.#followReferences(propertyNode.children[1])];
236+
yield [
237+
propertyNode.children[0].value,
238+
await this.#followReferences(propertyNode.children[1])
239+
];
233240
}
234241
}
235242
}

‎src/hyperjump/uri-schemes/file-scheme-plugin.d.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ import { Hyperjump } from "../hyperjump.js";
66
* Supports the `file:` URI scheme. Media type is determined by file extensions.
77
*/
88
export class FileUriSchemePlugin implements UriSchemePlugin {
9-
constructor(hyperjump: Hyperjump);
9+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
10+
constructor(hyperjump: Hyperjump<any>);
1011
schemes: string[];
1112
retrieve: UriSchemePlugin["retrieve"];
1213
}

‎src/hyperjump/uri-schemes/file-scheme-plugin.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export class FileUriSchemePlugin {
1515
#hyperjump;
1616

1717
/**
18-
* @param {Hyperjump} hyperjump
18+
* @param {Hyperjump<any>} hyperjump
1919
*/
2020
constructor(hyperjump) {
2121
this.schemes = ["file"];

‎src/hyperjump/uri-schemes/http-scheme-plugin.d.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ import { UriSchemePlugin } from "./uri-scheme-plugin.d.ts";
77
* representng all registered media types.
88
*/
99
export class HttpUriSchemePlugin implements UriSchemePlugin {
10-
constructor(hyperjump: Hyperjump);
10+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
11+
constructor(hyperjump: Hyperjump<any>);
1112

1213
schemes: string[];
1314

‎src/hyperjump/uri-schemes/http-scheme-plugin.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
/**
22
* @import { Hyperjump } from "../index.js"
3-
* @import { UriSchemePlugin } from "./uri-scheme-plugin.js"
43
* @import * as API from "./http-scheme-plugin.d.ts"
54
*/
65

@@ -11,7 +10,7 @@ export class HttpUriSchemePlugin {
1110
#successStatus;
1211

1312
/**
14-
* @param {Hyperjump} hyperjump
13+
* @param {Hyperjump<any>} hyperjump
1514
*/
1615
constructor(hyperjump) {
1716
this.schemes = ["http", "https"];

‎src/jref/jref-parse.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ import { VFileMessage } from "vfile-message";
33
import { fromJref } from "./jref-util.js";
44

55
/**
6-
* @import { VFile } from "vfile"
76
* @import { Options } from "vfile-message"
87
* @import { JrefDocumentNode } from "./jref-ast.js"
98
* @import * as API from "./jref-parse.d.ts"
@@ -12,7 +11,6 @@ import { fromJref } from "./jref-util.js";
1211

1312
/** @type API.jrefParse */
1413
export function jrefParse(options) {
15-
/** @type (document: string, file: VFile) => JrefDocumentNode */
1614
this.parser = function (document, file) {
1715
try {
1816
const uri = pathToFileURL(file.path).toString();

‎src/jref/jref-stringify.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
import { toJref } from "./jref-util.js";
22

33
/**
4-
* @import { Node } from "unist"
54
* @import { JrefDocumentNode } from "./jref-ast.js"
65
* @import * as API from "./jref-stringify.d.ts"
76
*/
87

98

109
/** @type API.jrefStringify */
1110
export function jrefStringify(options) {
12-
/** @type (tree: Node) => string */
1311
this.compiler = (tree) => {
1412
const jrefDocument = /** @type JrefDocumentNode */ (tree);
1513
return toJref(jrefDocument.children[0], jrefDocument.uri, options?.replacer, options?.space) + "\n";

‎src/json/rejson-parse.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import { VFileMessage } from "vfile-message";
22
import { fromJson } from "./jsonast-util.js";
33

44
/**
5-
* @import { VFile } from "vfile"
65
* @import { Options } from "vfile-message"
76
* @import { JsonDocumentNode } from "./jsonast.js"
87
* @import * as API from "./rejson-parse.d.ts"
@@ -11,7 +10,6 @@ import { fromJson } from "./jsonast-util.js";
1110

1211
/** @type API.rejsonParse */
1312
export function rejsonParse(options) {
14-
/** @type (document: string, file: VFile) => JsonDocumentNode */
1513
this.parser = function (document, file) {
1614
try {
1715
/** @type JsonDocumentNode */

‎src/json/rejson-stringify.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
import { toJson } from "./jsonast-util.js";
22

33
/**
4-
* @import { Node } from "unist"
54
* @import { JsonDocumentNode } from "./jsonast.js"
65
* @import * as API from "./rejson-stringify.d.ts"
76
*/
87

98

109
/** @type API.rejsonStringify */
1110
export function rejsonStringify(options) {
12-
/** @type (tree: Node) => string */
1311
this.compiler = (tree) => {
1412
return toJson(/** @type JsonDocumentNode */ (tree).children[0], options?.replacer, options?.space) + "\n";
1513
};

0 commit comments

Comments
 (0)