@fxi/zartigl 0.14.0 → 0.14.2

package/dist/zartigl.d.ts

@@ -65,6 +65,8 @@ export declare interface CatalogEntry {
     aliases?: string[];
     title: LocalizedText;
     description?: LocalizedText;
+    /** Methodology and sources: an immutable page published with the catalog. */
+    documentation?: string;
     category: string;
     tags?: string[];
     kind: "scalar" | "vector";
@@ -172,6 +174,42 @@ declare interface CatalogZarrSource extends CatalogSourceBase {
     variables: CatalogVariables;
 }
 
+/**
+ * A persistent store of Zarr chunks, as the compressed bytes the server sent,
+ * in the browser's Cache Storage. ZarrSource reads it before the network when
+ * given one (opt-in), so an app opens the chunks of a past session at once.
+ *
+ * Chunks of the to_zarr stores never change once written, except those of the
+ * last time chunk, which grows as months are appended. Those carry a revision
+ * (the length of the time axis): a stored chunk of another revision is stale
+ * and is read again, then replaced under the same key. A new store version has
+ * new URLs, so it never meets the chunks of the previous one.
+ */
+/** A stored chunk, without its bytes. */
+declare interface ChunkEntry {
+    url: string;
+    /** Bytes on disk (compressed). */
+    size: number;
+    /** When the chunk was stored, ms since the epoch. */
+    storedAt: number;
+    revision: string;
+}
+
+declare interface ChunkStore {
+    /** The bytes of `url`, or undefined when missing or of another revision. */
+    get(url: string, revision?: string): Promise<Uint8Array | undefined>;
+    put(url: string, bytes: Uint8Array, revision?: string): Promise<void>;
+    /** Every stored chunk whose URL starts with `prefix`. */
+    entries(prefix?: string): Promise<ChunkEntry[]>;
+    /** Removes these chunks. */
+    delete(urls: Iterable<string>): Promise<void>;
+    /** Origin storage use and quota, bytes, when the browser reports them. */
+    estimate(): Promise<{
+        usage: number;
+        quota: number;
+    } | undefined>;
+}
+
 export declare const COLOR_GRADE_OFF: Readonly<ColorGrade>;
 
 export declare const COLOR_GRADE_VIBRANT: Readonly<ColorGrade>;
@@ -1438,7 +1476,18 @@ export declare class ZarrSource {
     private maxCacheSize;
     private abortControllers;
     private bloscCodecCache;
-    constructor(root: string, maxCacheSize?: number);
+    private chunkStore;
+    /**
+     * `options.chunkStore` keeps the compressed chunks across sessions (see
+     * chunkStore.ts); without it, chunks are only kept in memory.
+     */
+    constructor(root: string, maxCacheSize?: number, options?: {
+        chunkStore?: ChunkStore;
+    });
+    /** The URL of a chunk, as fetched and as stored. */
+    chunkUrl(variable: string, indices: number[]): string;
+    /** The revision a stored chunk must carry to be current (see chunkRevision). */
+    chunkRevision(variable: string, indices: number[]): string;
     init(): Promise<void>;
     private getArrayMeta;
     private getAttrs;