@databiosphere/findable-ui 50.7.0 → 50.7.1

package/src/common/categories/config/types.ts

@@ -1,41 +0,0 @@
-import { Chart } from "../../chart/types";
-import {
-  CategoryKey,
-  DataDictionaryAnnotation,
-  SelectCategoryValueView,
-} from "../../entities";
-import { RangeViewKind } from "../views/range/types";
-import { SelectViewKind } from "../views/select/types";
-
-/**
- * Category config.
- */
-export type CategoryConfig = RangeCategoryConfig | SelectCategoryConfig;
-
-/**
- * Common category config.
- */
-export interface CommonCategoryConfig {
-  annotation?: DataDictionaryAnnotation;
-  key: CategoryKey;
-  label: string; // human readable label
-}
-
-/**
- * Range category config.
- */
-export interface RangeCategoryConfig
-  extends CommonCategoryConfig, RangeViewKind {
-  unit?: string; // e.g. "kg"
-}
-
-/**
- * Select category config.
- */
-export interface SelectCategoryConfig
-  extends CommonCategoryConfig, SelectViewKind {
-  chart?: Chart;
-  mapSelectCategoryValue?: (
-    selectCategoryValue: SelectCategoryValueView,
-  ) => SelectCategoryValueView;
-}

package/src/common/categories/config/utils.ts

@@ -1,50 +0,0 @@
-import { Category } from "../models/types";
-import { VIEW_KIND } from "../views/types";
-import { CategoryConfig } from "./types";
-
-/**
- * Returns the category config for the given category config key and view kind.
- * @param viewKind - View kind.
- * @param key - Category config key.
- * @param configs - Category configs.
- * @returns category config.
- */
-export function findCategoryConfig<V extends VIEW_KIND>(
-  viewKind: V,
-  key: Category["key"],
-  configs: CategoryConfig[],
-): Extract<CategoryConfig, { viewKind?: V }> | undefined {
-  return configs.find(
-    (c): c is Extract<CategoryConfig, { viewKind?: V }> =>
-      // When `viewKind` is undefined, it corresponds to a `SelectCategoryConfig`.
-      // This predicate ensures that `viewKind` is either explicitly matched or treated as undefined
-      // for compatibility with `SelectCategoryConfig` and other explicitly defined view kinds.
-      (c.viewKind === undefined || c.viewKind === viewKind) && c.key === key,
-  );
-}
-
-/**
- * Returns the range category config for the given category config key.
- * @param key - Category config key.
- * @param configs - Category configs.
- * @returns category config.
- */
-export function findRangeCategoryConfig(
-  key: Category["key"],
-  configs: CategoryConfig[],
-): Extract<CategoryConfig, { viewKind: VIEW_KIND.RANGE }> | undefined {
-  return findCategoryConfig(VIEW_KIND.RANGE, key, configs);
-}
-
-/**
- * Returns the select category config for the given category config key.
- * @param key - Category config key.
- * @param configs - Category configs.
- * @returns category config.
- */
-export function findSelectCategoryConfig(
-  key: Category["key"],
-  configs: CategoryConfig[],
-): Extract<CategoryConfig, { viewKind?: VIEW_KIND.SELECT }> | undefined {
-  return findCategoryConfig(VIEW_KIND.SELECT, key, configs);
-}

package/src/common/categories/models/range/typeGuards.ts

@@ -1,24 +0,0 @@
-import { Category } from "../types";
-import { RangeCategory, SelectedRange } from "./types";
-
-/**
- * Determine if category is a range category.
- * @param category - Category to check if range category.
- * @returns true if category is a range category.
- */
-export function isRangeCategory(category: Category): category is RangeCategory {
-  return "max" in category && "min" in category;
-}
-
-/**
- * Determine if value is a selected range.
- * @param value - Value to check if selected range.
- * @returns true if value is a selected range.
- */
-export function isSelectedRange(value: unknown): value is SelectedRange {
-  return (
-    Array.isArray(value) &&
-    value.length === 2 &&
-    value.every((v) => v === null || typeof v === "number")
-  );
-}

package/src/common/categories/models/range/types.ts

@@ -1,17 +0,0 @@
-import { CategoryKey } from "../../../entities";
-
-/**
- * Internal filter model of a range category.
- */
-export interface RangeCategory {
-  key: CategoryKey;
-  max: number;
-  min: number;
-  selectedMax: SelectedRange[1];
-  selectedMin: SelectedRange[0];
-}
-
-/**
- * Min and max values selected in range category.
- */
-export type SelectedRange = [number | null, number | null];

package/src/common/categories/models/range/utils.ts

@@ -1,51 +0,0 @@
-import { CategoryValueKey, SelectedFilter } from "../../../entities";
-import { isSelectedRange } from "./typeGuards";
-import { SelectedRange } from "./types";
-
-/**
- * Asserts that the given value is a selected range.
- * Throws an error if the value is not a selected range.
- * @param value - Value to assert is a selected range.
- */
-export function assertIsRange(value: unknown): asserts value is SelectedRange {
-  if (!isSelectedRange(value)) {
-    throw new Error("Value is not SelectedRange");
-  }
-}
-
-/**
- * Build the next filter state for the given range category.
- * @param nextCategorySelectedFilter - Next filter state for the range category.
- * @param selectedValue - Selected value for the range category.
- * @param selected - Whether the category value is selected.
- */
-export function buildNextRangeFilterState(
-  nextCategorySelectedFilter: SelectedFilter,
-  selectedValue: CategoryValueKey,
-  selected: boolean,
-): void {
-  if (selected) {
-    // Assert that the selected value is a range.
-    assertIsRange(selectedValue);
-    // Set the selected range.
-    nextCategorySelectedFilter.value = selectedValue;
-  } else {
-    // Remove the selected range.
-    nextCategorySelectedFilter.value = [];
-  }
-}
-
-/**
- * Get the selected values for the given category, if any.
- * Handles type checking for selected range.
- * Falls back to empty array if no selected values or invalid type (should never happen).
- * @param categorySelectedFilter - Current filter state for a category.
- * @returns The selected filter (i.e. the set of selected values) for the given category.
- */
-export function getRangeSelectedValue(
-  categorySelectedFilter?: SelectedFilter,
-): SelectedRange {
-  return isSelectedRange(categorySelectedFilter?.value)
-    ? categorySelectedFilter?.value
-    : [null, null];
-}

package/src/common/categories/models/select/utils.ts

@@ -1,23 +0,0 @@
-import { CategoryValueKey, SelectedFilter } from "../../../entities";
-
-/**
- * Build the next filter state for the given select category.
- * @param nextCategorySelectedFilter - Next filter state for the select category.
- * @param selectedValue - Selected value for the select category.
- * @param selected - Whether the category value is selected.
- */
-export function buildNextSelectFilterState(
-  nextCategorySelectedFilter: SelectedFilter,
-  selectedValue: CategoryValueKey,
-  selected: boolean,
-): void {
-  if (selected) {
-    // Set the selected value.
-    nextCategorySelectedFilter.value.push(selectedValue);
-  } else {
-    // Remove the selected value from the selected set of values.
-    nextCategorySelectedFilter.value = nextCategorySelectedFilter.value.filter(
-      (value: CategoryValueKey) => value !== selectedValue,
-    );
-  }
-}

package/src/common/categories/models/types.ts

@@ -1,7 +0,0 @@
-import { SelectCategory } from "../../entities";
-import { RangeCategory } from "./range/types";
-
-/**
- * Internal filter model of a category.
- */
-export type Category = SelectCategory | RangeCategory;

package/src/common/categories/views/common/types.ts

@@ -1,11 +0,0 @@
-import { CategoryKey, DataDictionaryAnnotation } from "../../../entities";
-
-/**
- * Common properties for category views.
- */
-export interface BaseCategoryView {
-  annotation?: DataDictionaryAnnotation;
-  isDisabled?: boolean;
-  key: CategoryKey;
-  label: string;
-}

package/src/common/categories/views/range/typeGuards.ts

@@ -1,13 +0,0 @@
-import { CategoryView } from "../types";
-import { RangeCategoryView } from "./types";
-
-/**
- * Returns true if the category view is a range category view.
- * @param view - Category view.
- * @returns true if the category view is a range category view.
- */
-export function isRangeCategoryView(
-  view: CategoryView,
-): view is RangeCategoryView {
-  return "max" in view && "min" in view;
-}

package/src/common/categories/views/range/types.ts

@@ -1,21 +0,0 @@
-import { SelectedRange } from "../../models/range/types";
-import { BaseCategoryView } from "../common/types";
-import { VIEW_KIND } from "../types";
-
-/**
- * View model of range category.
- */
-export interface RangeCategoryView extends BaseCategoryView {
-  max: number;
-  min: number;
-  selectedMax: SelectedRange[1];
-  selectedMin: SelectedRange[0];
-  unit?: string;
-}
-
-/**
- * Model of range category view kind.
- */
-export interface RangeViewKind {
-  viewKind: VIEW_KIND.RANGE;
-}

package/src/common/categories/views/range/utils.ts

@@ -1,35 +0,0 @@
-import { SelectedFilter } from "../../../entities";
-import { CategoryConfig } from "../../config/types";
-import { findRangeCategoryConfig } from "../../config/utils";
-import { RangeCategory } from "../../models/range/types";
-import { getRangeSelectedValue } from "../../models/range/utils";
-import { RangeCategoryView } from "../../views/range/types";
-
-/**
- * Build the view-specific model of the given range category.
- * @param category - The range category to build a view model of.
- * @param categoryConfigs - Category configs indicating accept list as well as label configuration.
- * @param categorySelectedFilter - Current filter state for a category.
- * @returns Full built range category view, ready for display.
- */
-export function buildRangeCategoryView(
-  category: RangeCategory,
-  categoryConfigs: CategoryConfig[],
-  categorySelectedFilter?: SelectedFilter,
-): RangeCategoryView {
-  const categoryConfig = findRangeCategoryConfig(category.key, categoryConfigs);
-  const [selectedMin, selectedMax] = getRangeSelectedValue(
-    categorySelectedFilter,
-  );
-  return {
-    annotation: categoryConfig?.annotation,
-    isDisabled: false,
-    key: category.key,
-    label: categoryConfig?.label || category.key,
-    max: category.max,
-    min: category.min,
-    selectedMax,
-    selectedMin,
-    unit: categoryConfig?.unit,
-  };
-}

package/src/common/categories/views/select/typeGuards.ts

@@ -1,13 +0,0 @@
-import { SelectCategoryView } from "../../../entities";
-import { CategoryView } from "../types";
-
-/**
- * Returns true if the category view is a select category view.
- * @param view - Category view.
- * @returns true if the category view is a select category view.
- */
-export function isSelectCategoryView(
-  view: CategoryView,
-): view is SelectCategoryView {
-  return "values" in view;
-}

package/src/common/categories/views/select/types.ts

@@ -1,8 +0,0 @@
-import { VIEW_KIND } from "../types";
-
-/**
- * Model of select category view kind.
- */
-export interface SelectViewKind {
-  viewKind?: VIEW_KIND.SELECT;
-}

package/src/common/categories/views/types.ts

@@ -1,15 +0,0 @@
-import { SelectCategoryView } from "../../entities";
-import { RangeCategoryView } from "./range/types";
-
-/**
- * Possible category view model types.
- */
-export type CategoryView = RangeCategoryView | SelectCategoryView;
-
-/**
- * Category view kind.
- */
-export enum VIEW_KIND {
-  RANGE = "RANGE",
-  SELECT = "SELECT",
-}

package/src/common/chart/sort/constants.ts

@@ -1,13 +0,0 @@
-import {
-  sortCategoryValueViewsAlpha,
-  sortCategoryValueViewsCount,
-} from "../../filters/sort/models/utils";
-import { CHART_SORT, ChartSortFn } from "./types";
-
-/**
- * Map of chart sort options to their corresponding sort functions.
- */
-export const CHART_SORT_FN: Record<CHART_SORT, ChartSortFn> = {
-  [CHART_SORT.ALPHA]: sortCategoryValueViewsAlpha,
-  [CHART_SORT.COUNT]: sortCategoryValueViewsCount,
-};

package/src/common/chart/sort/types.ts

@@ -1,22 +0,0 @@
-import { SelectCategoryValueView } from "../../entities";
-
-/**
- * Chart sorting options for select categories.
- */
-export enum CHART_SORT {
-  ALPHA = "ALPHA",
-  COUNT = "COUNT",
-}
-
-/**
- * Sorting function type for select category values.
- */
-export type ChartSortFn = (
-  a: SelectCategoryValueView,
-  b: SelectCategoryValueView,
-) => number;
-
-/**
- * Chart sort options - either a preset (ALPHA, COUNT) or a custom sort function.
- */
-export type ChartSortOptions = CHART_SORT | ChartSortFn;

package/src/common/chart/sort/utils.ts

@@ -1,22 +0,0 @@
-import { CHART_SORT_FN } from "./constants";
-import { CHART_SORT, ChartSortOptions, ChartSortFn } from "./types";
-
-/**
- * Resolves chart sort options to a sorting function.
- * @param chartSortOptions - Chart sort option (ALPHA, COUNT, or custom function).
- * @returns Sorting function to use for chart data.
- */
-export function getChartSortFn(
-  chartSortOptions?: ChartSortOptions,
-): ChartSortFn {
-  // Default to COUNT sort if not specified.
-  if (!chartSortOptions) {
-    return CHART_SORT_FN[CHART_SORT.COUNT];
-  }
-  // If it's a custom function, return it directly.
-  if (typeof chartSortOptions === "function") {
-    return chartSortOptions;
-  }
-  // Otherwise, look up the function from the map.
-  return CHART_SORT_FN[chartSortOptions];
-}

package/src/common/chart/types.ts

@@ -1,6 +0,0 @@
-import { ChartSortOptions } from "./sort/types";
-
-export interface Chart {
-  enable: boolean;
-  sortBy?: ChartSortOptions;
-}

package/src/common/constants.ts

@@ -1,18 +0,0 @@
-/**
- * Case insensitive sorter
- */
-export const COLLATOR_CASE_INSENSITIVE = new Intl.Collator("en", {
-  numeric: true,
-  sensitivity: "base",
-});
-
-/**
- * Values to determine the index for each param.
- * https://host/explore/[slug]/[param-uuid]/[param-tab]
- * - ExploreView 0 returns the current UUID
- * - ExploreView 1 returns the current tab (or choose export)
- * - ExportView 2 returns the export method
- */
-export const PARAMS_INDEX_UUID = 0;
-export const PARAMS_INDEX_TAB = 1; // Note "export" (i.e. not a tab) can possibly be at this index too
-export const PARAMS_INDEX_EXPORT_METHOD = 2;

package/src/common/entities.ts

@@ -1,174 +0,0 @@
-import { RowData, TableOptions } from "@tanstack/react-table";
-import { Chart } from "./chart/types";
-
-/**
- * Model of a value of a metadata class.
- */
-export interface Attribute {
-  // Prefix to fragment mapping, e.g. cxg: "batch_condition", or, general tags e.g. tier: "Tier 1" and bionetwork: ["gut"]
-  annotations?: Record<string, string | string[] | undefined>; // 'undefined' allows for mix of keys across attributes e.g. tier, or tier and cxg, or cxg
-  classKey?: string; // Programmatic class name or key (e.g. cell, sample) the attribute belongs to.
-  description: string;
-  example?: string; // Free text example of attribute
-  multivalued: boolean; // True if attribute can have multiple values
-  name: string; // Programmatic slot name or key (e.g. batch_condition, biosamples.anatomical_site)
-  range: string; // Type of attribute value e.g. "string"
-  rationale?: string; // Free text rationale for attribute
-  required: boolean;
-  title: string; // Display name
-  values?: string; // Free text description of attribute values
-}
-
-/**
- * Filterable metadata keys.
- */
-export type CategoryKey = string;
-
-/**
- * Clear all filters key.
- */
-export const CLEAR_ALL = "CLEAR_ALL" as const;
-
-/**
- * Clear all filters type.
- */
-export type ClearAll = typeof CLEAR_ALL;
-
-/**
- * View model of category tag.
- */
-export interface CategoryTag {
-  label: string;
-  onRemove: () => void;
-  superseded: boolean;
-}
-
-/**
- * Model of a metadata class, to be specified manually or built from LinkML schema.
- */
-export interface Class<T extends RowData = Attribute> {
-  attributes: T[];
-  description: string;
-  name: string; // Programmatic name or key (e.g. cell, sample)
-  title: string; // Display name
-}
-
-/**
- * Category values to be used as keys. For example, "Homo sapiens" or "10X 3' v2 sequencing".
- */
-export type CategoryValueKey = unknown;
-
-/**
- * Key value pair where the key is an identifier for a schema and the value is
- * a URL to the schema definition.
- */
-export type DataDictionaryPrefix = Record<string, string>;
-
-/**
- * Model of a metadata dictionary containing a set of classes and their definitions.
- */
-export interface DataDictionary<T extends RowData = Attribute> {
-  annotations?: {
-    [key in keyof DataDictionaryPrefix]: string; // Prefix to title e.g. "cxg": "CELLxGENE"
-  };
-  classes: Class<T>[];
-  description?: string; // Free text description of data dictionary
-  name: string; // Programmatic name or key (e.g. tier1, hca)
-  prefixes?: DataDictionaryPrefix;
-  title: string; // Display name
-}
-
-/**
- * Configuration of data dictionary; contains schema definition (that is, the actual data
- * dictionary) as well as column def for displaying the data dictionary.
- */
-export interface DataDictionaryConfig<T extends RowData = Attribute> {
-  dataDictionary: DataDictionary<T>;
-  path: string; // Used as a key to find the dictionary to display
-  tableOptions: Omit<TableOptions<T>, "data" | "getCoreRowModel">;
-}
-
-/**
- * Label and description values from a data dictionary that are added to a site
- * config value.
- */
-export interface DataDictionaryAnnotation {
-  description: string;
-  label: string;
-}
-
-/**
- * Set of selected category values.
- */
-export type Filters = SelectedFilter[];
-
-/**
- * Generic pagination model used by both static and dynamic lists.
- */
-export interface Pagination {
-  canNextPage: boolean;
-  canPreviousPage: boolean;
-  currentPage: number;
-  nextPage: () => void;
-  previousPage: () => void;
-  resetPage: () => void;
-}
-
-/**
- * Possible pagination direction values.
- */
-export type PaginationDirectionType = "next" | "prev";
-
-/**
- * Internal filter model of a multiselect category (e.g. library construction approach).
- */
-export interface SelectCategory {
-  key: CategoryKey;
-  label: string;
-  values: SelectCategoryValue[];
-}
-
-/**
- * Internal filter model of a multiselect category value (e.g. "10x 3' v1").
- */
-export interface SelectCategoryValue {
-  count: number;
-  key: CategoryValueKey;
-  label: string; // Allows for displaying null values as "Unspecified"
-  selected: boolean;
-}
-
-/**
- * View model of category value, selected state and count for single or multiselect categories.
- */
-export interface SelectCategoryValueView {
-  count: number;
-  key: CategoryValueKey;
-  label: string;
-  selected: boolean;
-}
-
-/**
- * View model of category, for multiselect categories.
- */
-export interface SelectCategoryView {
-  annotation?: DataDictionaryAnnotation;
-  chart?: Chart;
-  isDisabled?: boolean;
-  key: CategoryKey;
-  label: string;
-  values: SelectCategoryValueView[];
-}
-
-/**
- * Model of selected category values in a category.
- */
-export interface SelectedFilter {
-  categoryKey: CategoryKey;
-  value: SelectedFilterValue;
-}
-
-/**
- * Possible types of selected category values.
- */
-export type SelectedFilterValue = CategoryValueKey[];

package/src/common/filters/sort/config/types.ts

@@ -1,14 +0,0 @@
-/**
- * Filter sort options.
- */
-export enum FILTER_SORT {
-  ALPHA = "ALPHA",
-  COUNT = "COUNT",
-}
-
-/**
- * Filter sort configuration for site config.
- */
-export interface FilterSortConfig {
-  sortBy?: FILTER_SORT;
-}

package/src/common/filters/sort/config/utils.ts

@@ -1,11 +0,0 @@
-import { SiteConfig } from "../../../../config/entities";
-import { FILTER_SORT } from "./types";
-
-/**
- * Returns the default filter sort type "ALPHA" or "COUNT" from config or ALPHA as fallback.
- * @param config - Filter sort configuration.
- * @returns default filter sort type.
- */
-export function getFilterSortType(config?: SiteConfig): FILTER_SORT {
-  return config?.filterSort?.sortBy ?? FILTER_SORT.ALPHA;
-}