@genome-spy/app 0.76.0 → 0.77.0

package/package.json

@@ -8,7 +8,7 @@
   "contributors": [],
   "license": "MIT",
   "homepage": "https://genomespy.app/",
-  "version": "0.76.0",
+  "version": "0.77.0",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
   "type": "module",
@@ -70,7 +70,7 @@
     "@fortawesome/fontawesome-free": "^6.4.2",
     "@fortawesome/fontawesome-svg-core": "^6.4.2",
     "@fortawesome/free-solid-svg-icons": "^6.4.2",
-    "@genome-spy/core": "^0.76.0",
+    "@genome-spy/core": "^0.77.0",
     "@reduxjs/toolkit": "^2.11.0",
     "d3-color": "^3.1.0",
     "idb": "^7.1.1",
@@ -82,7 +82,7 @@
     "zarrita": "^0.6.1"
   },
   "devDependencies": {
-    "@genome-spy/app-agent": "^0.76.0"
+    "@genome-spy/app-agent": "^0.77.0"
   },
-  "gitHead": "34d821cf5e864972afaa65a3290719e2fdb209c2"
+  "gitHead": "2851e22e2069a70d7d02e3ab707b7556573aa17e"
 }

package/src/agentApi/index.d.ts

@@ -23,12 +23,36 @@ import type {
 } from "../charts/sampleAttributePlotTypes.d.ts";
 import type { ScaleResolutionApi } from "@genome-spy/core/types/scaleResolutionApi.js";
 import type UnitView from "@genome-spy/core/view/unitView.js";
+
+export interface AgentMetadataSourceIdentifierSummary {
+    name: string;
+    primary?: boolean;
+    caseInsensitive?: boolean;
+    stripVersionSuffix?: boolean;
+    examples: string[];
+}
+
+export interface AgentMetadataSourceSummary {
+    sourceId?: string;
+    name?: string;
+    description?: string;
+    attributeDefaults?: {
+        dataType?: string;
+        description?: string;
+    };
+    identifiers: AgentMetadataSourceIdentifierSummary[];
+}
+
 export interface AgentApi {
     /**
      * Returns the current sample hierarchy used by the agent context.
      */
     getSampleHierarchy(): SampleHierarchy | undefined;
 
+    getMetadataSourceSummaries(
+        signal?: AbortSignal
+    ): Promise<AgentMetadataSourceSummary[]>;
+
     getAttributeInfo(attribute: AttributeIdentifier): AttributeInfo | undefined;
 
     /**

package/src/sampleView/sampleViewTypes.d.ts

@@ -6,6 +6,7 @@ import { Scalar } from "@genome-spy/core/spec/channel.js";
 import { ComplexDomain, NumericDomain } from "@genome-spy/core/spec/scale.js";
 import { AggregationSpec, Interval } from "./types.js";
 import ViewContext from "@genome-spy/core/types/viewContext.js";
+import { SampleLayoutDef } from "@genome-spy/app/spec/sampleView.js";
 import type {
     ParamSelector,
     ViewSelector,
@@ -54,6 +55,7 @@ export interface LocationContext {
     onLocationUpdate: (arg: { sampleHeight: number }) => void;
     viewContext: ViewContext;
     isStickySummaries: () => boolean;
+    sampleLayout?: SampleLayoutDef;
 }
 
 export interface BaseSpecifier {

package/src/sampleView/state/payloadTypes.d.ts

@@ -329,6 +329,90 @@ export interface RemoveGroup {
     path: string[];
 }
 
+export interface RetainGroupsByRank {
+    /**
+     * One-based grouping level to filter.
+     *
+     * `1` targets top-level groups under ROOT. `2` targets direct children of
+     * level-1 groups, and so on. For top-level categories such as cancer type,
+     * use `1`.
+     *
+     * @minimum 1
+     */
+    level: number;
+
+    /**
+     * Group-level measure used for ranking.
+     *
+     * Only `"size"` is supported. Size means group abundance: the number of
+     * descendant visible samples in the group.
+     */
+    measure: "size";
+
+    /**
+     * Number of ranked groups to retain within each ancestor partition.
+     *
+     * This is k in top-k or bottom-k requests. For example, use `5` to keep
+     * the five largest or five smallest groups.
+     *
+     * @minimum 1
+     */
+    limit: number;
+
+    /**
+     * Ranking direction.
+     *
+     * Use `"descending"` for top-k, highest values, largest groups by size, or
+     * most abundant groups. Use `"ascending"` for bottom-k, lowest values,
+     * smallest groups by size, or least abundant groups.
+     */
+    order: "descending" | "ascending";
+}
+
+export interface RetainGroupsBySize {
+    /**
+     * One-based grouping level to filter.
+     *
+     * `1` targets top-level groups under ROOT. `2` targets direct children of
+     * level-1 groups, and so on. For top-level categories such as cancer type,
+     * use `1`.
+     *
+     * @minimum 1
+     */
+    level: number;
+
+    /**
+     * Group-level measure used for thresholding.
+     *
+     * Only `"size"` is supported. Size means group abundance: the number of
+     * descendant visible samples in the group.
+     */
+    measure: "size";
+
+    /**
+     * Threshold comparison applied as `measure operator operand`.
+     */
+    operator: ComparisonOperatorType;
+
+    /**
+     * Numeric group-size threshold.
+     */
+    operand: number;
+}
+
+export interface Ungroup {
+    /**
+     * One-based grouping level to collapse.
+     *
+     * `1` collapses top-level groups under ROOT and all deeper levels into one
+     * flat ROOT sample group. `2` keeps level-1 groups but collapses their
+     * children and all deeper levels into sample lists.
+     *
+     * @minimum 1
+     */
+    level: number;
+}
+
 /**
  * Payload for filtering samples by comparing a quantitative attribute
  * against a numeric operand.

package/src/sampleView/types.d.ts

@@ -82,6 +82,9 @@ export interface AttributeInfo {
     /** More detailed name with optional formatting */
     title: string | import("lit").TemplateResult;
 
+    /** Plain short label for compact contexts and summaries. */
+    shortTitle?: string;
+
     /** Formatted attribute name for context menus (e.g., with selective emphasis). */
     emphasizedName: string | import("lit").TemplateResult;
 

package/src/spec/sampleView.d.ts

@@ -32,6 +32,11 @@ export interface SampleSpec extends Omit<ViewSpecBase, "templates"> {
      */
     metadata?: MetadataDef;
 
+    /**
+     * Layout settings for sample rows and sample groups.
+     */
+    sampleLayout?: SampleLayoutDef;
+
     /**
      * An object defining the view background and outline. The background is
      * repeated for each group.
@@ -90,6 +95,16 @@ export interface SampleAttributeDef {
      */
     barScale?: Scale;
 
+    /**
+     * Color used for metadata cells whose value is missing.
+     *
+     * If `null`, no background is drawn for missing values in this attribute.
+     * If omitted, `metadata.missingValueColor` is used. If both are
+     * omitted, the default is `null` when `barScale` is configured and
+     * `"#f0f0f0"` otherwise.
+     */
+    missingValueColor?: string | null;
+
     /**
      * Width of the column in pixels.
      */
@@ -377,6 +392,16 @@ export interface MetadataDef {
      */
     attributeWidth?: number;
 
+    /**
+     * Default color for metadata cells whose value is missing.
+     *
+     * If `null`, missing-value colors are disabled unless overridden by an
+     * attribute definition.
+     *
+     * __Default value:__ `"#f0f0f0"`
+     */
+    missingValueColor?: string | null;
+
     /**
      * Spacing between metadata columns in pixels.
      *
@@ -485,3 +510,36 @@ export interface SampleDef {
      */
     labelAlign?: Align;
 }
+
+export interface SampleLayoutDef {
+    /**
+     * Height of one sample row when the view is expanded for (close-up) inspection.
+     * In the birdseye overview, sample rows are automatically scaled to fit the available vertical space.
+     *
+     * __Default value:__ `35`
+     */
+    sampleHeight?: number;
+
+    /**
+     * Spacing between sample groups in the fitted layout.
+     *
+     * __Default value:__ `5`
+     */
+    groupSpacing?: number;
+
+    /**
+     * Spacing between sample groups in the expanded layout.
+     *
+     * __Default value:__ `15`
+     */
+    peekGroupSpacing?: number;
+
+    /**
+     * Fraction of each sample row reserved as spacing between rendered sample contents.
+     *
+     * Spacing is reduced when rows are too short to render cleanly.
+     *
+     * __Default value:__ `0.2`
+     */
+    sampleSpacingFactor?: number;
+}

package/dist/esm-BY4T8YoD.js

@@ -1,142 +0,0 @@
-import { n as e, t } from "./chunk-CPXzm0be.js";
-//#region ../../node_modules/generic-filehandle2/esm/blobFile.js
-var n = class {
-	constructor(e) {
-		this.blob = e;
-	}
-	async read(e, t = 0) {
-		if (!e) return new Uint8Array();
-		let n = t, r = n + e, i = this.blob.slice(n, r);
-		return i.bytes ? i.bytes() : new Uint8Array(await i.arrayBuffer());
-	}
-	async readFile(e) {
-		let t = typeof e == "string" ? e : e?.encoding;
-		if (t === "utf8") return this.blob.text();
-		if (t) throw Error(`unsupported encoding: ${t}`);
-		return this.blob.bytes ? this.blob.bytes() : new Uint8Array(await this.blob.arrayBuffer());
-	}
-	async stat() {
-		return { size: this.blob.size };
-	}
-	async close() {}
-};
-//#endregion
-//#region ../../node_modules/generic-filehandle2/esm/remoteFile.js
-function r(e) {
-	return (typeof e == "object" && e && "message" in e ? e.message : `${e}`).replace(/\.$/, "");
-}
-var i = class {
-	constructor(e, t = {}) {
-		this.baseOverrides = {}, this.url = e;
-		let n = t.fetch || globalThis.fetch.bind(globalThis);
-		t.overrides && (this.baseOverrides = t.overrides), this.fetchImplementation = n;
-	}
-	async fetch(e, t) {
-		let n = (t) => Error(`${r(t)} fetching ${e}`, { cause: t }), i;
-		try {
-			i = await this.fetchImplementation(e, t);
-		} catch (r) {
-			if (`${r}`.includes("Failed to fetch")) {
-				console.warn(`generic-filehandle: refetching ${e} to attempt to work around chrome CORS header caching bug`);
-				try {
-					i = await this.fetchImplementation(e, {
-						...t,
-						cache: "reload"
-					});
-				} catch (e) {
-					throw n(e);
-				}
-			} else throw n(r);
-		}
-		return i;
-	}
-	async read(e, t, n = {}) {
-		if (e === 0) return new Uint8Array();
-		let { headers: r = {}, signal: i, overrides: a = {} } = n;
-		e < Infinity ? r.range = `bytes=${t}-${t + e - 1}` : e === Infinity && t !== 0 && (r.range = `bytes=${t}-`);
-		let o = await this.fetch(this.url, {
-			...this.baseOverrides,
-			...a,
-			headers: {
-				...this.baseOverrides.headers,
-				...a.headers,
-				...r
-			},
-			method: "GET",
-			redirect: "follow",
-			mode: "cors",
-			signal: i
-		});
-		if (!o.ok) throw Error(`HTTP ${o.status} fetching ${this.url}`);
-		if (o.status === 200 && t === 0 || o.status === 206) {
-			let t = o.headers.get("content-range"), n = /\/(\d+)$/.exec(t || "");
-			n?.[1] && (this._stat = { size: parseInt(n[1], 10) });
-			let r = o.bytes ? await o.bytes() : new Uint8Array(await o.arrayBuffer());
-			return r.byteLength <= e ? r : r.subarray(0, e);
-		}
-		throw Error(o.status === 200 ? `${this.url} fetch returned status 200, expected 206` : `HTTP ${o.status} fetching ${this.url}`);
-	}
-	async readFile(e = {}) {
-		let t, n;
-		if (typeof e == "string") t = e, n = {};
-		else {
-			t = e.encoding;
-			let { encoding: r, ...i } = e;
-			n = i;
-		}
-		let { headers: r = {}, signal: i, overrides: a = {} } = n, o = await this.fetch(this.url, {
-			...this.baseOverrides,
-			...a,
-			headers: {
-				...this.baseOverrides.headers,
-				...a.headers,
-				...r
-			},
-			method: "GET",
-			redirect: "follow",
-			mode: "cors",
-			signal: i
-		});
-		if (!o.ok) throw Error(`HTTP ${o.status} fetching ${this.url}`);
-		if (t === "utf8") return o.text();
-		if (t) throw Error(`unsupported encoding: ${t}`);
-		return o.bytes ? o.bytes() : new Uint8Array(await o.arrayBuffer());
-	}
-	async stat() {
-		if (!this._stat && (await this.read(10, 0), !this._stat)) throw Error(`unable to determine size of file at ${this.url}`);
-		return this._stat;
-	}
-	async close() {}
-}, a = (/* @__PURE__ */ t(((e, t) => {
-	t.exports = {};
-})))(), o = class {
-	constructor(e, t = {}) {
-		this.filename = e;
-	}
-	async read(e, t = 0) {
-		if (e === 0) return new Uint8Array();
-		let n = new Uint8Array(e), r;
-		try {
-			r = await (0, a.open)(this.filename, "r");
-			let i = await r.read(n, 0, e, t);
-			return i.buffer.subarray(0, i.bytesRead);
-		} finally {
-			if (r) try {
-				await r.close();
-			} catch {}
-		}
-	}
-	async readFile(e) {
-		return (0, a.readFile)(this.filename, e);
-	}
-	async stat() {
-		return (0, a.stat)(this.filename);
-	}
-	async close() {}
-}, s = /* @__PURE__ */ e({
-	BlobFile: () => n,
-	LocalFile: () => o,
-	RemoteFile: () => i
-});
-//#endregion
-export { o as n, i as r, s as t };