Add options for ReferenceStore (#155)

Author: keller-mark

.changeset/something.md

@@ -0,0 +1,5 @@
+---
+"@zarrita/storage": patch
+---
+
+Add support for passing fetch options to ReferenceStore.

packages/storage/src/fetch.ts

@@ -1,5 +1,5 @@
 import type { AbsolutePath, AsyncReadable, RangeQuery } from "./types.js";
-import { fetch_range } from "./util.js";
+import { fetch_range, merge_init } from "./util.js";
 
 function resolve(root: string | URL, path: AbsolutePath): URL {
 	const base = typeof root === "string" ? new URL(root) : root;
@@ -72,14 +72,7 @@ class FetchStore implements AsyncReadable<RequestInit> {
 	}
 
 	#merge_init(overrides: RequestInit) {
-		return {
-			...this.#overrides,
-			...overrides,
-			headers: {
-				...this.#overrides.headers,
-				...overrides.headers,
-			},
-		};
+		return merge_init(this.#overrides, overrides);
 	}
 
 	async get(

packages/storage/src/ref.ts

@@ -1,5 +1,5 @@
 import { parse } from "reference-spec-reader";
-import { fetch_range, strip_prefix, uri2href } from "./util.js";
+import { fetch_range, merge_init, strip_prefix, uri2href } from "./util.js";
 import type { AbsolutePath, AsyncReadable } from "./types.js";
 
 /**
@@ -36,19 +36,22 @@ type ReferenceEntry = string | [url: string | null] | [
 
 interface ReferenceStoreOptions {
 	target?: string | URL;
+	overrides?: RequestInit;
 }
 
 /** @experimental */
 class ReferenceStore implements AsyncReadable<RequestInit> {
 	#refs: Map<string, ReferenceEntry>;
 	#opts: ReferenceStoreOptions;
+	#overrides: RequestInit;
 
 	constructor(
 		refs: Map<string, ReferenceEntry>,
 		opts: ReferenceStoreOptions = {},
 	) {
 		this.#refs = refs;
 		this.#opts = opts;
+		this.#overrides = opts.overrides || {};
 	}
 
 	async get(
@@ -72,7 +75,12 @@ class ReferenceStore implements AsyncReadable<RequestInit> {
 			throw Error(`No url for key ${key}, and no target url provided.`);
 		}
 
-		let res = await fetch_range(uri2href(url), offset, size, opts);
+		let res = await fetch_range(
+			uri2href(url),
+			offset,
+			size,
+			merge_init(this.#overrides, opts),
+		);
 
 		if (res.status === 200 || res.status === 206) {
 			return new Uint8Array(await res.arrayBuffer());
@@ -89,7 +97,7 @@ class ReferenceStore implements AsyncReadable<RequestInit> {
 	}
 
 	static async fromUrl(url: string | URL, opts?: ReferenceStoreOptions) {
-		let spec = await fetch(url).then((res) => res.json());
+		let spec = await fetch(url, opts?.overrides).then((res) => res.json());
 		return ReferenceStore.fromSpec(spec, opts);
 	}
 }

packages/storage/src/util.ts

@@ -40,3 +40,18 @@ export function fetch_range(
 	}
 	return fetch(url, opts);
 }
+
+export function merge_init(
+	storeOverrides: RequestInit,
+	requestOverrides: RequestInit,
+) {
+	// Request overrides take precedence over storeOverrides.
+	return {
+		...storeOverrides,
+		...requestOverrides,
+		headers: {
+			...storeOverrides.headers,
+			...requestOverrides.headers,
+		},
+	};
+}