@morscherlab/mint-sdk 1.2.0-beta.3 → 1.2.0-beta.5

package/src/types/componentWorkflowTypes.ts

@@ -0,0 +1,190 @@
+import type { UserSummary } from './platform'
+
+// ScientificNumber types
+export type NumberNotation = 'auto' | 'scientific' | 'engineering' | 'compact'
+
+// UnitInput types
+export interface UnitOption {
+  value: string
+  label: string
+  factor?: number
+  group?: string
+}
+
+// StepWizard types
+export interface WizardStep {
+  id: string
+  label: string
+  description?: string
+  icon?: string
+  optional?: boolean
+}
+
+export type WizardStepState = 'pending' | 'active' | 'completed' | 'disabled'
+
+// AuditTrail types
+export type AuditEntryType = 'create' | 'update' | 'delete' | 'system'
+
+export interface AuditEntry {
+  id: string
+  type: AuditEntryType
+  action: string
+  detail?: string
+  user?: string
+  timestamp: Date | string
+  metadata?: Record<string, unknown>
+}
+
+// BatchProgressList types
+export type BatchItemStatus = 'pending' | 'processing' | 'completed' | 'error' | 'skipped'
+
+export interface BatchItem {
+  id: string
+  label: string
+  status: BatchItemStatus
+  progress?: number
+  message?: string
+}
+
+export interface BatchSummary {
+  total: number
+  completed: number
+  processing: number
+  error: number
+  pending: number
+  skipped: number
+  percent: number
+}
+
+// TimePicker types
+export type TimePickerFormat = '12h' | '24h'
+
+export interface TimeRange {
+  start: string  // "HH:mm"
+  end: string    // "HH:mm"
+}
+
+// Schedule types
+export type ScheduleView = 'day' | 'week' | 'month'
+export type ScheduleEventStatus = 'confirmed' | 'pending' | 'cancelled' | 'in-progress'
+
+export interface ScheduleEvent {
+  id: string
+  start: string          // ISO 8601 datetime
+  end: string            // ISO 8601 datetime
+  title: string
+  color?: string
+  status?: ScheduleEventStatus
+  draggable?: boolean
+  resizable?: boolean
+  metadata?: Record<string, unknown>
+}
+
+export interface ScheduleBlockedSlot {
+  start: string
+  end: string
+  label?: string
+}
+
+export interface ScheduleSlotContext {
+  date: Date
+  hour: number
+  minute: number
+}
+
+export interface ScheduleEventCreateContext {
+  start: Date
+  end: Date
+}
+
+export interface ScheduleEventUpdateContext {
+  event: ScheduleEvent
+  newStart: Date
+  newEnd: Date
+}
+
+// Summary data types (for ExperimentDataViewer compact mode)
+export interface SummarySectionItem {
+  label: string
+  metadata?: Record<string, unknown>
+  item_count: number
+  item_key: string
+  columns: string[]
+  rows: Record<string, unknown>[]
+}
+
+export interface SummarySection {
+  key: string
+  label: string
+  type: 'table' | 'group'
+  /** Group sections: list of group items with embedded tables */
+  items?: SummarySectionItem[]
+  /** Table sections: flat table columns and rows */
+  columns?: string[]
+  rows?: Record<string, unknown>[]
+  row_count?: number
+}
+
+export interface SummaryData {
+  metadata: Record<string, unknown>
+  sections: SummarySection[]
+}
+
+// Resource types
+export type ResourceStatus = 'available' | 'in-use' | 'maintenance' | 'offline'
+
+export interface ResourceSpec {
+  label: string
+  value: string
+}
+
+// Experiment selector types
+export type ExperimentStatus = 'planned' | 'ongoing' | 'completed' | 'cancelled'
+export type DatePreset = 'last_7_days' | 'last_30_days' | 'last_90_days'
+export type ExperimentSortField = 'created_at' | 'updated_at' | 'name' | 'status'
+
+export interface ExperimentTypeOption {
+  value: string
+  label: string
+  color?: string
+}
+
+export interface ExperimentSummary {
+  id: number
+  experiment_code?: string
+  name: string
+  status: ExperimentStatus
+  experiment_type: string
+  project?: string
+  project_id?: number
+  project_name?: string
+  notes?: string
+  tags?: Record<string, unknown>
+  created_at: string
+  updated_at: string
+  created_by?: number
+  created_by_user?: UserSummary
+  has_design_data: boolean
+}
+
+export interface ExperimentListResponse {
+  experiments: ExperimentSummary[]
+  total: number
+}
+
+export interface ExperimentFilters {
+  search?: string
+  status?: ExperimentStatus | null
+  project?: string | null
+  experimentType?: string | null
+  datePreset?: DatePreset | null
+}
+
+// FitPanel types
+export type FitState = 'idle' | 'running' | 'completed' | 'error'
+
+export interface FitResultSummary {
+  label: string
+  value: string | number
+  variant?: 'default' | 'success' | 'warning' | 'error'
+}

package/src/types/components.ts

@@ -0,0 +1,527 @@
+import type { AccessControlled, AccessAudience, AccessAudienceInput } from '../permissions'
+
+// Container types
+export type ContainerDirection = 'row' | 'column'
+
+// Button types
+export type ButtonVariant = 'primary' | 'secondary' | 'cta' | 'danger' | 'success' | 'ghost'
+export type ButtonSize = 'sm' | 'md' | 'lg'
+
+// Action menu types
+interface ActionMenuItemBase {
+  id: string
+  label: string
+  disabled?: boolean
+  danger?: boolean
+}
+
+export type ActionMenuItem =
+  | (ActionMenuItemBase & {
+      href?: never
+      target?: never
+    })
+  | (ActionMenuItemBase & {
+      href: string
+      target?: '_self' | '_blank' | '_parent' | '_top'
+    })
+
+// Input types
+export type InputType = 'text' | 'password' | 'email' | 'number' | 'search' | 'tel' | 'url'
+
+// Modal types
+export type ModalSize = 'sm' | 'md' | 'lg' | 'xl' | 'full'
+export type ModalVariant = 'centered' | 'drawer' | 'sheet'
+export type ModalLayout = 'plain' | 'tabs' | 'rail'
+
+/** Section descriptor for BaseModal's shell-level tab strip (layout="tabs") or rail (layout="rail"). */
+export interface ModalTab {
+  id: string
+  label: string
+  /** Monospace meta on the right of the label — a count, "2 unsaved", etc. No colored badge pill. */
+  meta?: string
+  /**
+   * Rail only — 1rem stroke icon. Accepts SVG path data (string or string[])
+   * or trusted inline SVG markup rendered with `v-html`. Markup must be
+   * plugin-author-controlled — never user-supplied data.
+   */
+  icon?: string | string[]
+  /** Rail only — second line under the label; also shown as the pane subtitle. */
+  description?: string
+  disabled?: boolean
+}
+
+// Alert types
+export type AlertType = 'success' | 'error' | 'warning' | 'info'
+
+// Toast types
+export interface Toast {
+  id: number
+  message: string
+  type: 'success' | 'error' | 'warning' | 'info'
+  duration?: number
+}
+
+// Tab types
+export interface TabItem {
+  id: string
+  label: string
+  icon?: string | string[]
+  disabled?: boolean
+  badge?: string | number
+}
+
+export type TabItemInput = TabItem | string
+
+// Select types
+export type OptionPrimitive = string | number
+
+export interface SelectOption<T = string> {
+  value: T
+  label: string
+  disabled?: boolean
+  description?: string
+}
+
+export type SelectOptionInput<T extends OptionPrimitive = OptionPrimitive> = SelectOption<T> | T
+
+// Radio types
+export interface RadioOption {
+  value: string | number
+  label: string
+  disabled?: boolean
+  description?: string
+}
+
+export type RadioOptionInput = RadioOption | OptionPrimitive
+
+// Form field types
+export interface FormFieldProps {
+  label?: string
+  error?: string
+  hint?: string
+  required?: boolean
+}
+
+// Section card types
+export type SectionCardAccent =
+  | 'primary'
+  | 'experiment'
+  | 'project'
+  | 'success'
+  | 'error'
+  | 'warning'
+  | 'info'
+
+export type SectionCardDivider = 'strong' | 'light'
+
+// Sidebar types
+export type SidebarBadgeTone =
+  | 'primary'
+  | 'cta'
+  | 'success'
+  | 'warning'
+  | 'error'
+  | 'info'
+  | 'neutral'
+
+export interface SidebarToolSectionAction {
+  id: string
+  label: string
+  icon?: string | string[]
+  iconColor?: string
+  tone?: SidebarBadgeTone
+  disabled?: boolean
+}
+
+export interface SidebarToolSection {
+  id: string
+  label: string
+  subtitle?: string
+  icon?: string | string[]
+  iconColor?: string
+  iconBg?: string
+  badge?: string | number
+  badgeTone?: SidebarBadgeTone
+  actions?: SidebarToolSectionAction[]
+  defaultOpen?: boolean
+  showToggle?: boolean
+}
+
+// Collapsible types
+export interface CollapsibleState {
+  isOpen: boolean
+  toggle: () => void
+  open: () => void
+  close: () => void
+}
+
+// TopBar types
+export type TopBarVariant = 'card' | 'default'
+
+export interface PillNavOption {
+  id: string
+  label: string
+  to?: string
+  href?: string
+  description?: string
+  disabled?: boolean
+}
+
+export type PillNavOptionInput = PillNavOption | string
+
+// TopBar settings config (pass-through for built-in SettingsModal)
+export interface TopBarSettingsConfig {
+  title?: string
+  tabs?: SettingsTabInput[]
+  showAppearance?: boolean
+  size?: 'md' | 'lg' | 'xl'
+  layout?: SettingsModalLayout
+  /** Schema-driven config — when set, fields auto-render via SDK form components. */
+  schema?: SettingsModalSchema
+  /** Model returned by defineControlModel(), or a raw nested ControlModel for one-step settings generation. */
+  model?:
+    | import('../composables/useControlSchema').ControlModel
+    | import('../composables/useControlSchema').ControlModelBinding
+  /** Compact controls model — converted to `schema` when `schema` is not set. */
+  controls?: import('../composables/useControlSchema').ControlSchema
+  /** Conversion options for `controls`, such as section labels and columns. */
+  controlOptions?: import('../composables/useControlSchema').ControlSchemaOptions
+  /** Initial values when using `schema`, `model`, or `controls`. AppTopBar emits `settings-values-change` on change. */
+  values?: Record<string, unknown>
+  /** Dynamic enhancements (validators, dynamic options, callbacks). Forwarded to SettingsModal. */
+  enhancements?: import('./form-builder').FormEnhancements
+  /** Optional user type override for permission-filtered settings content. Defaults to SDK auth/platform context. */
+  userType?: SettingsUserType
+}
+
+// TopBar pill-nav items (centered top-level navigation)
+export interface PillNavItem {
+  id: string
+  label: string
+  icon?: string | string[]
+  to?: string
+  href?: string
+  disabled?: boolean
+  children?: PillNavOption[]
+}
+
+export type PillNavItemInput = (Omit<PillNavItem, 'children'> & {
+  children?: PillNavOptionInput[]
+}) | string
+
+// TopBar page selector items (left-side "go to page" dropdown)
+export interface PageSelectorItem {
+  id: string
+  label: string
+  icon?: string
+  hint?: string
+  to?: string
+  href?: string
+  disabled?: boolean
+}
+
+export type PageSelectorItemInput = PageSelectorItem | string
+
+// TopBar plugin switcher info
+export interface PluginSwitcherPlugin {
+  id: string
+  label: string
+  color?: string
+  version?: string
+  to?: string
+  href?: string
+}
+
+export interface PluginSwitcherInfo {
+  current: PluginSwitcherPlugin
+  plugins?: PluginSwitcherPlugin[]
+  installHref?: string
+  installTo?: string
+}
+
+// Avatar/account menu items
+export interface AccountMenuItem {
+  id: string
+  label: string
+  icon?: string
+  rightLabel?: string
+  to?: string
+  href?: string
+  danger?: boolean
+  divider?: boolean
+}
+
+export type {
+  WellPlateFormat,
+  WellState,
+  WellPlateSelectionMode,
+  WellPlateSize,
+  WellShape,
+  Well,
+  HeatmapColorScale,
+  HeatmapConfig,
+  SlotPosition,
+  WellExtendedData,
+  WellEditData,
+  WellEditField,
+  WellSampleDropData,
+  WellSampleDropContext,
+  WellSampleDropParser,
+  WellLegendItem,
+  PlateCondition,
+  ColumnCondition,
+  RowCondition,
+  Rack,
+  RackSampleDropContext,
+  RackSampleDropMapper,
+  SampleType,
+  PlateMap,
+  PlateMapEditorState,
+  ProtocolStepType,
+  ProtocolStepStatus,
+  ProtocolStep,
+  SampleGroup,
+  GroupItem,
+  FileUploaderMode,
+  MoleculeData,
+  StorageCondition,
+  ReagentColumn,
+  Reagent,
+  TreeNodeType,
+  BadgeVariant,
+  TreeNode,
+} from './componentLabTypes'
+
+// SegmentedControl types
+export interface SegmentedOption {
+  value: string | number
+  label: string
+  description?: string
+  disabled?: boolean
+}
+
+export type SegmentedOptionInput = SegmentedOption | OptionPrimitive
+
+export type SegmentedControlVariant = 'simple' | 'card'
+export type SegmentedControlSize = 'sm' | 'md' | 'lg'
+
+// MultiSelect types
+export interface MultiSelectOption {
+  value: string | number
+  label: string
+  disabled?: boolean
+}
+
+export type MultiSelectOptionInput = MultiSelectOption | OptionPrimitive
+
+export type MultiSelectSize = 'sm' | 'md' | 'lg'
+
+// Pill types
+/** Visual style variant for pill/badge components */
+export type PillVariant = 'default' | 'primary' | 'success' | 'warning' | 'error' | 'info' | 'outline'
+/** Semantic color modifier for pill components — combine with variant="outline" for colored outlines */
+export type PillColor = 'neutral' | 'primary' | 'success' | 'warning' | 'error' | 'info'
+/** Size variant for pill components */
+export type PillSize = 'sm' | 'md' | 'lg'
+
+// Calendar types
+/** Date selection behavior for calendar component */
+export type CalendarSelectionMode = 'none' | 'single' | 'range' | 'multiple'
+
+/** Visual marker displayed on a calendar date */
+export interface CalendarMarker {
+  /** Date to mark */
+  date: Date | string
+  /** Marker color (CSS color value) */
+  color?: string
+  /** Tooltip/label for the marker */
+  label?: string
+  /** Visual style of the marker */
+  type?: 'dot' | 'bar' | 'highlight'
+  /** Additional custom data */
+  customData?: Record<string, unknown>
+}
+
+/** Context object for a calendar day cell */
+export interface CalendarDayContext {
+  /** The date for this day */
+  date: Date
+  /** Day of month (1-31) */
+  dayOfMonth: number
+  /** True if this is today's date */
+  isToday: boolean
+  /** True if this date is currently selected */
+  isSelected: boolean
+  /** True if this date is within a selected range */
+  isInRange: boolean
+  /** True if this date cannot be selected */
+  isDisabled: boolean
+  /** True if this date is from an adjacent month */
+  isOutsideMonth: boolean
+  /** Markers configured for this date */
+  markers: CalendarMarker[]
+}
+
+// DataFrame types
+/** Sort direction (null means unsorted) */
+export type SortDirection = 'asc' | 'desc' | null
+
+/** Current sort state for a table column */
+export interface SortState {
+  /** Column key being sorted */
+  key: string
+  /** Sort direction */
+  direction: SortDirection
+}
+
+/** Column configuration for DataFrame component */
+export interface DataFrameColumn<T = Record<string, unknown>> {
+  /** Unique column key (supports nested keys like 'user.name') */
+  key: string
+  /** Display label for column header */
+  label: string
+  /** Enable sorting for this column */
+  sortable?: boolean
+  /** Text alignment */
+  align?: 'left' | 'center' | 'right'
+  /** Fixed column width */
+  width?: string | number
+  /** Minimum column width */
+  minWidth?: string | number
+  /** Truncate overflow text with ellipsis */
+  ellipsis?: boolean
+  /** Custom formatter for cell values */
+  formatter?: (value: unknown, row: T, index: number) => string
+}
+
+/** Pagination state for table data */
+export interface PaginationState {
+  /** Current page (1-indexed) */
+  page: number
+  /** Number of rows per page */
+  pageSize: number
+  /** Total number of rows across all pages */
+  total: number
+}
+
+// LoadingSpinner types
+export type SpinnerSize = 'xs' | 'sm' | 'md' | 'lg'
+export type SpinnerVariant = 'primary' | 'cta' | 'muted'
+
+// Divider types
+export type DividerSpacing = 'sm' | 'md' | 'lg'
+
+// StatusIndicator types
+export type StatusType = 'success' | 'warning' | 'error' | 'info' | 'muted'
+
+// ProgressBar types
+export type ProgressVariant = 'rail' | 'segmented'
+export type ProgressColor = 'primary' | 'success' | 'warning' | 'error' | 'info'
+export type ProgressSize = 'sm' | 'md' | 'lg'
+
+// Avatar types
+export type AvatarSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl'
+
+// EmptyState types
+export type EmptyStateColor = 'primary' | 'cta' | 'success' | 'warning' | 'error' | 'muted'
+export type EmptyStateSize = 'sm' | 'md' | 'lg'
+
+// Breadcrumb types
+export interface BreadcrumbItem {
+  label: string
+  to?: string
+  href?: string
+}
+
+export type BreadcrumbItemInput = BreadcrumbItem | string
+
+// Tooltip types
+export type TooltipPosition = 'top' | 'bottom' | 'left' | 'right'
+
+// ConfirmDialog types
+export type ConfirmVariant = 'danger' | 'warning' | 'info'
+
+// SettingsModal types
+export interface SettingsTab extends AccessControlled {
+  id: string
+  label: string
+  /**
+   * Inline SVG markup rendered with `v-html` in the vertical layout's rail.
+   * Must be trusted, plugin-author-controlled markup — never user-supplied data.
+   */
+  icon?: string
+  /** Optional one-line hint shown under the label (vertical layout) and as a section subtitle in the right pane. */
+  description?: string
+  /** Optional monospace meta shown right of the tab label — a count, "2 unsaved", etc. */
+  meta?: string
+}
+
+export type SettingsTabInput = SettingsTab | string
+
+export type SettingsModalLayout = 'horizontal' | 'vertical'
+
+/**
+ * Declarative settings group — becomes both a tab and a generated form section.
+ * Plugin authors describe their parameters once and the modal auto-renders
+ * SDK form components (BaseInput / BaseSelect / NumberInput / Toggle / …)
+ * via the same registry that powers FormBuilder.
+ */
+export interface SettingsGroup extends AccessControlled {
+  id: string
+  label: string
+  description?: string
+  /**
+   * Inline SVG markup rendered with `v-html` in the vertical layout's rail.
+   * Must be trusted, plugin-author-controlled markup — never user-supplied data.
+   */
+  icon?: string
+  /** SDK form-builder field schemas. */
+  fields: import('./form-builder').FormFieldSchema[]
+  /** Grid columns for the rendered fields (1-3). Defaults to 1. */
+  columns?: 1 | 2 | 3
+  /** Hide the entire group (rail item + content) when this evaluates false against the form data. */
+  condition?: import('./form-builder').FieldCondition
+}
+
+export interface SettingsModalSchema {
+  groups: SettingsGroup[]
+}
+
+export type SettingsUserType = Exclude<AccessAudience, 'all'>
+export type SettingsAudience = AccessAudience
+export type SettingsAudienceInput = AccessAudienceInput
+
+export type {
+  NumberNotation,
+  UnitOption,
+  WizardStep,
+  WizardStepState,
+  AuditEntryType,
+  AuditEntry,
+  BatchItemStatus,
+  BatchItem,
+  BatchSummary,
+  TimePickerFormat,
+  TimeRange,
+  ScheduleView,
+  ScheduleEventStatus,
+  ScheduleEvent,
+  ScheduleBlockedSlot,
+  ScheduleSlotContext,
+  ScheduleEventCreateContext,
+  ScheduleEventUpdateContext,
+  SummarySectionItem,
+  SummarySection,
+  SummaryData,
+  ResourceStatus,
+  ResourceSpec,
+  ExperimentStatus,
+  DatePreset,
+  ExperimentSortField,
+  ExperimentTypeOption,
+  ExperimentSummary,
+  ExperimentListResponse,
+  ExperimentFilters,
+  FitState,
+  FitResultSummary,
+} from './componentWorkflowTypes'