omezarr-tilesource 0.7.1 → 0.8.1

package/README.md

@@ -23,8 +23,7 @@ pnpm add omezarr-tilesource
 ```
 
 The package is distributed as an ES module for use with a bundler (e.g. Vite).
-[zarrita](https://github.com/manzt/zarrita.js),
-[@zarrita/storage](https://github.com/manzt/zarrita.js) and
+[zarrita](https://github.com/manzt/zarrita.js) and
 [ome-zarr.js](https://github.com/BioNGFF/ome-zarr.js) are peer dependencies
 (installed automatically by pnpm and npm 7 or newer) and are not bundled, so
 the app and the tile source share a single copy, e.g. for passing `NgffImage`
@@ -207,7 +206,20 @@ const tileSource2 = new OMEZarrTileSource(
 
 `loadOMEZarr(url, zip?, { signal })` loads the metadata with ome-zarr.js and
 opens the arrays of all resolution levels; `url` may also be a `Blob` holding a
-zipped OME-Zarr file. An `OMEZarr` can also be assembled
+zipped OME-Zarr file, or a zarrita store (`Readable`, e.g. a custom
+`AsyncReadable`; `zip: true` is rejected, wrap zipped files in a `ZipFileStore`
+instead). Images loaded from a store can only be rendered by
+passing the `OMEZarr` to a tile source, with a `url` that identifies the store:
+
+```javascript
+const loaded = await OMEZarrTileSource.loadOMEZarr(myStore);
+const tileSource = await OMEZarrTileSource.open(
+  { url: "custom://my-image" },
+  loaded,
+);
+```
+
+An `OMEZarr` can also be assembled
 from an `NgffImage` loaded by the app, as long as `arrays` lists the
 opened arrays of `image.paths` in order. It is not checked against the URL of
 the tile source it is passed to.

package/dist/omezarr-tilesource.d.ts

@@ -30,7 +30,7 @@ export declare function getDataTypeRange(chunk: zarr.Chunk<zarr.NumberDataType |
  * @param url - URL to check, as a string or a `URL`
  * @returns Whether the URL path ends in `.ozx`
  */
-export declare function isOZX(url: string | URL): boolean;
+export declare function isOZXUrl(url: string | URL): boolean;
 
 /**
  * A color LUT (a color per scaled value, e.g. 256 entries) or a color map (a
@@ -149,19 +149,25 @@ export declare class OMEZarrTileSource extends default_2.TileSource {
      * Loads the OME-Zarr metadata and opens the arrays of all resolution levels.
      *
      * The result can be passed to the constructor or to {@link open} to share one
-     * metadata load across several tile sources for the same URL.
-     *
-     * @param url - URL of the OME-Zarr image or zipped OME-Zarr file, as a string
-     *   or a `URL` (relative URLs are resolved against the document base URL),
-     *   or a `Blob` (e.g. a `File`) holding a zipped OME-Zarr file
+     * metadata load across several tile sources for the same URL. Images loaded
+     * from a zarrita store can only be rendered this way, with a `url` that
+     * identifies the store (e.g. `custom://my-image`).
+     *
+     * @param store - URL of the OME-Zarr image or zipped OME-Zarr file, as a
+     *   string or a `URL` (relative URLs are resolved against the document base
+     *   URL), a `Blob` (e.g. a `File`) holding a zipped OME-Zarr file, or a
+     *   zarrita store (`Readable`, e.g. a custom `AsyncReadable`) holding the
+     *   OME-Zarr image
      * @param zip - Whether the URL points to a zipped OME-Zarr file; defaults to
-     *   `true` for URLs whose path ends in `.ozx` and for `Blob`s
+     *   `true` for URLs whose path ends in `.ozx` and for `Blob`s. Must not be
+     *   `false` for a `Blob`, and must not be `true` for a zarrita store (wrap
+     *   zipped files in a `ZipFileStore` instead)
      * @param options - `signal` aborts the load
      * @returns The loaded image and its arrays, highest resolution first
-     * @throws If the URL is relative and there is no document base URL, or if
-     *   `zip` is `false` for a `Blob`
+     * @throws If the URL is relative and there is no document base URL, if `zip`
+     *   is `false` for a `Blob`, or if `zip` is `true` for a zarrita store
      */
-    static loadOMEZarr(url: string | URL | Blob, zip?: boolean, options?: {
+    static loadOMEZarr(store: string | URL | Blob | zarr.Readable, zip?: boolean, options?: {
         signal?: AbortSignal;
     }): Promise<OMEZarr>;
     /**

package/dist/omezarr-tilesource.js

@@ -51,19 +51,17 @@ var d = class o extends i.TileSource {
 	}
 	static async loadOMEZarr(n, r, i) {
 		let { signal: a } = i ?? {};
-		a?.throwIfAborted();
-		let o;
-		if (n instanceof Blob) {
-			if (r === !1) throw Error("only zipped OME-Zarr files can be loaded from a Blob");
-			o = e.fromBlob(n);
-		} else {
+		if (a?.throwIfAborted(), typeof n == "string" || n instanceof URL) {
 			let t = s(n);
-			o = r ?? c(t) ? e.fromUrl(t) : n.toString();
-		}
-		let l = await t.load(o, { signal: a });
+			n = r ?? c(t) ? e.fromUrl(t) : n.toString();
+		} else if (n instanceof Blob) {
+			if (r === !1) throw Error("only zipped OME-Zarr files can be loaded from a Blob");
+			n = e.fromBlob(n);
+		} else if (r === !0) throw Error("zip must not be true for a zarrita store (wrap zipped OME-Zarr files in a ZipFileStore instead)");
+		let o = await t.load(n, { signal: a });
 		return {
-			image: l,
-			arrays: await Promise.all(l.paths.map((e) => l.openArray(e, { signal: a })))
+			image: o,
+			arrays: await Promise.all(o.paths.map((e) => o.openArray(e, { signal: a })))
 		};
 	}
 	static async open(e, t, n) {
@@ -311,4 +309,4 @@ var d = class o extends i.TileSource {
 //#region src/main.ts
 globalThis.OpenSeadragon && d.enable(globalThis.OpenSeadragon);
 //#endregion
-export { d as OMEZarrTileSource, u as fnv1a, l as getDataTypeRange, c as isOZX, s as resolveUrl };
+export { d as OMEZarrTileSource, u as fnv1a, l as getDataTypeRange, c as isOZXUrl, s as resolveUrl };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "omezarr-tilesource",
-  "version": "0.7.1",
+  "version": "0.8.1",
   "description": "An OpenSeadragon tile source for the OME-Zarr bioimage file format",
   "homepage": "https://github.com/TissUUmaps/OMEZarrTileSource#readme",
   "bugs": "https://github.com/TissUUmaps/OMEZarrTileSource/issues",
@@ -22,10 +22,12 @@
       "import": "./dist/omezarr-tilesource.js"
     }
   },
+  "dependencies": {
+    "@zarrita/storage": "^0.2.0"
+  },
   "peerDependencies": {
-    "@zarrita/storage": "^0.2.0",
-    "ome-zarr.js": ">=0.0.20 <0.1.0",
-    "openseadragon": ">=6.0.0 <7.0.0",
+    "ome-zarr.js": "^0.0.20",
+    "openseadragon": "^6.0.0",
     "zarrita": "^0.7.5"
   },
   "devDependencies": {
@@ -33,13 +35,12 @@
     "@microsoft/api-extractor": "^7.58.7",
     "@trivago/prettier-plugin-sort-imports": "^6.0.2",
     "@vitest/coverage-v8": "^4.1.7",
-    "@zarrita/storage": "0.2.0",
     "eslint": "^10.4.0",
     "eslint-config-prettier": "^10.1.8",
     "husky": "^9.1.7",
     "lint-staged": "^17.0.5",
     "ome-zarr.js": "0.0.20",
-    "openseadragon": "^6.1.1",
+    "openseadragon": "^6.0.0",
     "prettier": "^3.8.3",
     "typescript": "^6.0.3",
     "typescript-eslint": "^8.59.4",