@databiosphere/findable-ui 50.6.0 → 50.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@databiosphere/findable-ui",
-  "version": "50.6.0",
+  "version": "50.6.1",
   "description": "",
   "scripts": {
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
@@ -21,6 +21,11 @@
   },
   "homepage": "https://github.com/DataBiosphere/findable-ui/tree/main/#readme",
   "main": "lib/index.js",
+  "files": [
+    "lib",
+    "src",
+    "types"
+  ],
   "devDependencies": {
     "@commitlint/cli": "^20.2.0",
     "@commitlint/config-conventional": "^20.2.0",

package/.eslintignore

@@ -1,5 +0,0 @@
-**/node_modules/*
-**/out/*
-**/.next/*
-
-lib

package/.eslintrc.json

@@ -1,79 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "plugins": [
-    "@typescript-eslint",
-    "sonarjs",
-    "jsdoc",
-    "sort-destructure-keys",
-    "typescript-sort-keys",
-    "react-hooks"
-  ],
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "prettier",
-    "plugin:prettier/recommended",
-    "plugin:storybook/recommended",
-    "next",
-    "plugin:sonarjs/recommended",
-    "plugin:eslint-comments/recommended"
-  ],
-  "rules": {
-    "sort-keys": [
-      "error",
-      "asc",
-      {
-        "caseSensitive": true,
-        "minKeys": 2,
-        "natural": false
-      }
-    ],
-    "sort-destructure-keys/sort-destructure-keys": [
-      "error",
-      {
-        "caseSensitive": false
-      }
-    ],
-    "typescript-sort-keys/interface": [
-      "error",
-      "asc",
-      {
-        "caseSensitive": false
-      }
-    ],
-    "typescript-sort-keys/string-enum": [
-      "error",
-      "asc",
-      {
-        "caseSensitive": false
-      }
-    ],
-    "eslint-comments/require-description": "error",
-    "jsdoc/require-description": "error",
-    "jsdoc/require-param": "error",
-    "jsdoc/require-param-name": "error",
-    "jsdoc/require-param-description": "error",
-    "jsdoc/require-hyphen-before-param-description": "error",
-    "jsdoc/require-returns": "error",
-    "jsdoc/require-returns-description": "error",
-    "jsdoc/check-alignment": "error",
-    "jsdoc/check-param-names": "error",
-    "react-hooks/exhaustive-deps": "error"
-  },
-  "overrides": [
-    {
-      "files": "**",
-      "excludedFiles": "*.styles.ts?(x)",
-      "rules": {
-        "@typescript-eslint/explicit-function-return-type": "error"
-      }
-    },
-    {
-      "files": "**/*.test.ts",
-      "rules": {
-        "@typescript-eslint/no-explicit-any": "off",
-        "sonarjs/no-duplicate-string": "off"
-      }
-    }
-  ]
-}

package/.github/copilot-instructions.md

@@ -1,176 +0,0 @@
-# Copilot Instructions for findable-ui
-
-## Repository Purpose
-
-This is a TypeScript library package (`@databiosphere/findable-ui`) that provides reusable UI components and utilities for Data Biosphere applications, particularly the Data Browser. It's designed as an npm package that exports compiled JavaScript from the `lib` directory.
-
-## Key Project Information
-
-- **Language**: TypeScript with strict mode enabled
-- **Node Version**: 20.10.0 (enforced)
-- **UI Framework**: React 18 with Material-UI (MUI) v7
-- **Build System**: TypeScript compiler (tsc)
-- **Testing**: Jest with React Testing Library
-- **Package Type**: Library package that compiles to `lib/` directory
-
-## Repository Structure
-
-- `/src` - TypeScript source files (compiles to `/lib`)
-  - `/components` - React UI components
-  - `/hooks` - Custom React hooks
-  - `/providers` - React context providers
-  - `/utils` - Utility functions
-  - `/theme` - MUI theme configuration
-  - `/config` - Configuration files
-  - `/apis` - API client code
-  - `/services` - Business logic services
-  - `/types` - TypeScript type definitions
-  - `/views` - Page-level components
-- `/tests` - Jest test files (separate from src)
-- `/lib` - Compiled JavaScript output (git-ignored)
-- `/.storybook` - Storybook configuration
-
-## Code Style and Standards
-
-### TypeScript Requirements
-
-- **Strict mode enabled**: All TypeScript strict checks are enforced
-- **Explicit return types required**: All functions must have explicit return type annotations (except in `.styles.ts(x)` files)
-- **No implicit any**: Avoid `any` type; use proper typing (exceptions allowed in test files)
-- **Null safety**: Strict null checks are enforced
-
-### Code Organization
-
-- **Sort keys**: Object keys, destructured keys, interface properties, and string enums must be sorted alphabetically (enforced by ESLint)
-- **Import organization**: Imports are auto-organized with prettier-plugin-organize-imports
-- **File naming**: Use kebab-case for file names (e.g., `my-component.tsx`)
-
-### Documentation Requirements
-
-All code must include JSDoc comments with:
-
-- **Function descriptions**: Required for all functions
-- **Parameter documentation**: `@param` tags with descriptions for all parameters
-- **Return value documentation**: `@returns` tag with description
-- **Hyphen before param descriptions**: Required format
-
-Example:
-
-```typescript
-/**
- * Transforms a route by removing inactivity parameters.
- * @param routes - Array of route strings to transform.
- * @returns The first non-login route without inactivity param, or undefined.
- */
-function transformRoute(routes: string[]): string | undefined {
-  // implementation
-}
-```
-
-### React Patterns
-
-- **Hooks dependencies**: The `react-hooks/exhaustive-deps` rule is enforced - always include all dependencies in useEffect, useCallback, etc.
-- **Component structure**: Use functional components with hooks
-- **Styling**: Use Emotion styled components (`.styles.ts` or `.styles.tsx` files)
-
-## Build, Test, and Validation Steps
-
-### Before Making Changes
-
-1. Install dependencies: `npm ci`
-2. Run all checks to verify baseline:
-   ```bash
-   npm run check-format
-   npm run lint
-   npm run test
-   npm run test-compile
-   ```
-
-### During Development
-
-1. **Check formatting**: `npm run check-format` (Prettier)
-2. **Lint code**: `npm run lint` (ESLint with TypeScript, SonarJS, and other plugins)
-3. **Run tests**: `npm run test` (Jest with jsdom environment)
-4. **Type check**: `npm run test-compile` (TypeScript compiler without emit)
-5. **Compile library**: `npx tsc` (when making changes that need to be tested in consuming apps)
-
-### All PRs Must Pass
-
-- Prettier formatting check
-- ESLint with no errors
-- All Jest tests passing
-- TypeScript compilation without errors
-
-## Testing Guidelines
-
-- **Test location**: Tests live in the `/tests` directory (not co-located with source files)
-- **Test framework**: Jest with `@testing-library/react` for component tests
-- **Test naming**: Use `.test.ts` or `.test.tsx` extension
-- **Setup**: Tests use Storybook decorators and parameters (see `tests/setup.ts`)
-- **Mocking**: Global mocks for ResizeObserver, TextEncoder, and TextDecoder are pre-configured
-- **Test structure**: Follow the existing pattern of describe/it blocks with clear descriptions
-
-Example test structure:
-
-```typescript
-describe("ComponentName", () => {
-  it("should do something specific", () => {
-    // Arrange
-    const input = "test";
-
-    // Act
-    const result = functionUnderTest(input);
-
-    // Assert
-    expect(result).toBe("expected");
-  });
-});
-```
-
-## Contribution Workflow
-
-1. **Make minimal changes**: This is a library package - changes impact all consumers
-2. **Maintain backward compatibility**: Breaking changes require major version bumps
-3. **Update documentation**: Keep README and inline docs current
-4. **No breaking test changes**: Don't remove or modify existing tests unless fixing bugs
-5. **Test compilation**: Always run `npm run test-compile` to ensure TypeScript compilation succeeds
-
-## Peer Dependencies
-
-This package has extensive peer dependencies that consuming applications must provide:
-
-- React 18.3+
-- Material-UI (@mui/material, @mui/icons-material) v7
-- Next.js 14.2+ and next-auth
-- Emotion (@emotion/react, @emotion/styled)
-- TanStack Table and Virtual (@tanstack/react-table, @tanstack/react-virtual)
-- Various utilities (ky, uuid, yup, etc.)
-
-**Do not add these as direct dependencies** - they must remain as peer dependencies.
-
-## Common Pitfalls to Avoid
-
-1. **Don't import from lib/**: Always import from src/ during development
-2. **Don't add dependencies to dependencies**: New packages should go in peerDependencies or devDependencies
-3. **Don't disable ESLint rules without justification**: The strict rules maintain code quality
-4. **Don't skip JSDoc**: All public functions require documentation
-5. **Don't modify package-lock.json manually**: Use npm commands
-6. **Don't commit lib/ directory**: It's build output and git-ignored
-
-## Special Notes
-
-- **Storybook**: Available for component development (`npm run storybook`)
-- **Husky hooks**: Pre-commit hooks are configured via `.husky`
-- **Release management**: Uses release-please for automated versioning and changelog
-- **Link for local development**: Use `npm link` to test changes in Data Browser locally (see README)
-
-## Development with Data Browser
-
-When developing findable-ui alongside the Data Browser:
-
-1. Clone both repos in the same parent directory
-2. In findable-ui: Run `npm ci`, bump version, run `npx tsc`
-3. In data-browser/explorer: Run `npm link ../../findable-ui`
-4. May need to comment out certain packages in next.config.mjs webpack config
-
-See README.md for complete local development workflow.

package/.github/workflows/release-please.yml

@@ -1,49 +0,0 @@
-on:
-  push:
-    branches:
-      - main
-  workflow_dispatch: # Enable manual triggering
-
-permissions:
-  contents: write
-  pull-requests: write
-  id-token: write # Required for trusted publishing to npm
-
-name: release-please
-
-jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: googleapis/release-please-action@v4
-        id: release
-        with:
-          config-file: release-please-config.json
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      # The logic below handles the npm publication:
-      - uses: actions/checkout@v4
-
-      # These if statements ensure that a publication only occurs when a new release is created:
-      - uses: actions/setup-node@v4
-        if: ${{ steps.release.outputs.release_created }}
-        with:
-          node-version: "22.12.0"
-          registry-url: "https://registry.npmjs.org"
-          always-auth: true # Enable authentication for trusted publishing
-
-      - name: Upgrade npm for trusted publishing
-        if: ${{ steps.release.outputs.release_created }}
-        run: npm install -g npm@^11.5.1
-
-      - name: Install dependencies
-        if: ${{ steps.release.outputs.release_created }}
-        run: npm ci
-
-      - name: Compile
-        if: ${{ steps.release.outputs.release_created }}
-        run: npx tsc
-
-      - name: Publish to NPM
-        if: ${{ steps.release.outputs.release_created }}
-        run: npm publish --provenance --access public

package/.github/workflows/run-checks.yml

@@ -1,57 +0,0 @@
-name: Run checks
-on:
-  pull_request:
-    branches:
-      - "**"
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "22.12.0"
-          cache: "npm"
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Check code format
-        run: npm run check-format
-
-      - name: Run linter
-        run: npm run lint
-
-      - name: Run tests
-        run: npm run test
-
-      - name: Test compilation
-        run: npm run test-compile
-
-  install-without-lock:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "22.12.0"
-          cache: "npm"
-
-      - name: Remove package lock
-        run: rm package-lock.json
-
-      - name: Install dependencies without lock
-        run: npm install
-
-      - name: Run tests
-        run: npm run test
-
-      - name: Test compilation
-        run: npm run test-compile

package/.husky/commit-msg

@@ -1,18 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-echo "Checking commit message"
-
-# Check for issue number
-
-commit_regex='#[0-9]'
-error_msg="Aborting commit. Your commit message is missing a '#xxx' reference to a corresponding GitHub issue. Add '--no-verify' to your git commit command if you wish to skip this check."
-
-if ! grep -iqE "$commit_regex" "$1"; then
-    echo "$error_msg" >&2
-    exit 1
-fi
-
-# Check for Conventional Commits format
-
-npx commitlint --edit $1

package/.husky/pre-commit

@@ -1,43 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-echo '🏗️👷 Checking your project before committing'
-
-
-echo 'Checking findable-ui'
-
-# Check Prettier
-npm run check-format ||
-(
-    echo '🤔 Prettier Check Failed. Run npx prettier --write . try commit again.';
-    false;
-)
-
-# Check ESLint
-npm run lint ||
-(
-    echo '🤔  ESLint Check Failed. Make the required changes listed above, add changes and try to commit again.'
-    false; 
-)
-
-# Run tests
-npm test ||
-(
-	echo 'Tests failed';
-	false;
-)
-
-# Check Black (Python formatter)
-python -m black backend --check ||
-(
-	echo '🤔 Black Check Failed. Run: python -m black backend';
-	false;
-)
-
-# Check TypeScript
-npm run test-compile ||
-(
-	echo 'TypeScript compile failed';
-	false;
-)
-echo 'TypeScript compile succeeded!'

package/.prettierignore

@@ -1,19 +0,0 @@
-# general
-README.md
-CHANGELOG.md
-
-# testing
-coverage
-
-# next.js
-.next
-out
-
-# distribution
-lib
-
-# dependencies
-node_modules
-
-# editors
-.vscode

package/.prettierrc.json

@@ -1 +0,0 @@
-{}

package/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "50.6.0"
-}

package/.storybook/main.ts

@@ -1,10 +0,0 @@
-import { defineMain } from "@storybook/nextjs-vite/node";
-
-export default defineMain({
-  framework: "@storybook/nextjs-vite",
-  stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
-  core: {
-    builder: "@storybook/builder-vite",
-    disableTelemetry: true,
-  },
-});

package/.storybook/preview-head.html

@@ -1,4 +0,0 @@
-<style>
-  @import url("https://fonts.googleapis.com/css2?family=Inter:wght@400;500&display=swap");
-  @import url("https://fonts.googleapis.com/css2?family=Roboto+Mono&display=swap");
-</style>

package/.storybook/preview.js

@@ -1,6 +0,0 @@
-import "../src/index";
-import { decorators as projectDecorators } from "../src/storybook/decorators";
-import { parameters as projectParameters } from "../src/storybook/parameters";
-
-export const decorators = projectDecorators;
-export const parameters = projectParameters;