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

package/src/composables/index.ts

@@ -0,0 +1,530 @@
+export {
+  AuthenticationRequiredError,
+  useApi,
+  type ApiClientOptions,
+  type UseApiReturn,
+} from './useApi'
+export { useAuth } from './useAuth'
+export { usePasskey } from './usePasskey'
+export { useTheme } from './useTheme'
+export { useToast } from './useToast'
+export { usePlatformContext } from './usePlatformContext'
+export { resolvePluginFrontendBase } from './pluginFrontendBase'
+export {
+  getPresenceClientId,
+  usePresenceHeartbeat,
+  type PresenceHeartbeatOptions,
+  type PresenceHeartbeatPayload,
+  type PresenceHeartbeatResponse,
+  type UsePresenceHeartbeatReturn,
+} from './usePresenceHeartbeat'
+export {
+  getInjectedFrontendRevision,
+  useRuntimeAlignment,
+  type RuntimeAlignmentOptions,
+  type RuntimeRevisionResponse,
+  type UseRuntimeAlignmentReturn,
+} from './useRuntimeAlignment'
+export {
+  useForm,
+  type ValidationRule,
+  type FieldRules,
+  type FieldState,
+  type UseFormReturn,
+} from './useForm'
+export {
+  useAsync,
+  useAsyncBatch,
+  type AsyncError,
+  type AsyncState,
+  type UseAsyncReturn,
+  type UseAsyncOptions,
+} from './useAsync'
+export {
+  useWellPlateEditor,
+  type UseWellPlateEditorOptions,
+  type UseWellPlateEditorReturn,
+} from './useWellPlateEditor'
+export {
+  useConcentrationUnits,
+  type ConcentrationValue,
+  type ConcentrationUnit,
+  type MolarityUnit,
+  type MassVolumeUnit,
+  type PercentageUnit,
+  type UnitCategory,
+  type UseConcentrationUnitsReturn,
+} from './useConcentrationUnits'
+export {
+  useDoseCalculator,
+  type VolumeUnit,
+  type VolumeValue,
+  type DilutionParams,
+  type DilutionResult,
+  type SerialDilutionParams,
+  type SerialDilutionStep,
+  type SerialDilutionResult,
+  type ConversionResult,
+  type WellConcentration,
+  type UseDoseCalculatorReturn,
+} from './useDoseCalculator'
+export {
+  useProtocolTemplates,
+  type ParameterDefinition,
+  type StepTemplate,
+  type ValidationResult,
+  type UseProtocolTemplatesReturn,
+} from './useProtocolTemplates'
+export {
+  useRackEditor,
+  type UseRackEditorOptions,
+  type UseRackEditorReturn,
+} from './useRackEditor'
+export {
+  useChemicalFormula,
+  ATOMIC_WEIGHTS,
+  type ParsedElement,
+  type FormulaParseResult,
+  type FormulaPart,
+  type FormulaPartType,
+} from './useChemicalFormula'
+export {
+  useSequenceUtils,
+  type SequenceType,
+  type SequenceStats,
+} from './useSequenceUtils'
+export {
+  useTimeUtils,
+  parseTime,
+  formatTime,
+  formatTimeSlot,
+  generateTimeSlots,
+  rangesOverlap,
+  durationMinutes,
+  formatDuration,
+  isTimeInRange,
+  findAvailableSlots,
+  snapToSlot,
+  addMinutes,
+  compareTime,
+  findNearestTimeSlotIndex,
+  toMinutes,
+  fromMinutes,
+} from './useTimeUtils'
+export { useScheduleDrag } from './useScheduleDrag'
+export {
+  useEventListener,
+  type EventListenerEnabled,
+  type EventFor,
+  type EventListenerStop,
+  type EventMapFor,
+  type EventTargetGetter,
+  type EventTargetLike,
+  type UseEventListenerObjectOptions,
+  type UseEventListenerOptions,
+} from './useEventListener'
+export {
+  DEFAULT_MOBILE_VIEWPORT_QUERY,
+  useMobileSupportGate,
+  type MobileSupportSource,
+  type MobileViewportQuerySource,
+  type UseMobileSupportGateOptions,
+  type UseMobileSupportGateReturn,
+} from './useMobileSupportGate'
+export {
+  useDebouncedWatch,
+  type DebouncedWatchCallback,
+  type DebouncedWatchCleanup,
+  type DebouncedWatchSource,
+  type UseDebouncedWatchOptions,
+  type UseDebouncedWatchReturn,
+} from './useDebouncedWatch'
+export { useFormBuilder, evaluateCondition } from './useFormBuilder'
+export {
+  createGeneratedAnalysisTransport,
+  useGeneratedAnalysis,
+  usePluginJobs,
+  type GeneratedAnalysisTransport,
+  type GeneratedAnalysisOptions,
+  type PluginJobRequestOptions,
+  type PluginJobWaitOptions,
+  type UsePluginJobsOptions,
+  type UsePluginJobsReturn,
+  type UseGeneratedAnalysisReturn,
+} from './useGeneratedAnalysis'
+export { useAutoGroup, DEFAULT_COLORS, extractSamplesFromDesignData } from './useAutoGroup'
+export { usePluginConfig, type UsePluginConfigReturn } from './usePluginConfig'
+export {
+  useReagentSeries,
+  generateDilutionSeries,
+  DEFAULT_PRESETS,
+  DEFAULT_UNITS,
+  type LevelEntry,
+  type DilutionPreset,
+  type UseReagentSeriesReturn,
+} from './useReagentSeries'
+export {
+  useExperimentSelector,
+  type UseExperimentSelectorOptions,
+  type UseExperimentSelectorReturn,
+} from './useExperimentSelector'
+export {
+  useAnalysisArtifacts,
+  ANALYSIS_FILE_ARTIFACT_SCHEMA,
+  type UseAnalysisArtifactsOptions,
+  type UseAnalysisArtifactsReturn,
+} from './useAnalysisArtifacts'
+export {
+  buildAnalysisArtifactTargetQuery,
+  parseAnalysisArtifactTarget,
+} from './analysisArtifactTarget'
+export { resolveCurrentPluginId } from './platformContextHelpers'
+export {
+  formatExperimentDate,
+  formatExperimentStatus,
+  getExperimentStatusVariant,
+  resolveExperimentCode,
+  experimentIdFromRoute,
+  datePresetToISO,
+  EXPERIMENT_STATUS_OPTIONS,
+  EXPERIMENT_STATUS_VARIANT_MAP,
+  EXPERIMENT_STATUS_LABELS,
+  DATE_PRESET_OPTIONS,
+  SORT_OPTIONS,
+} from './experiment-utils'
+export {
+  useExperimentData,
+  type UseExperimentDataOptions,
+  type UseExperimentDataReturn,
+} from './useExperimentData'
+export {
+  extractSampleNamesFromDesignData,
+  extractSampleOptionsFromDesignData,
+  unwrapExperimentDesignData,
+  type ExperimentDesignDataResponse,
+  type ExtractExperimentSamplesOptions,
+} from './experimentDesignData'
+export {
+  useExperimentSamples,
+  type ExperimentDesignDataSource,
+  type ExperimentIdSource,
+  type UseExperimentSamplesOptions,
+  type UseExperimentSamplesReturn,
+} from './useExperimentSamples'
+export {
+  getFieldRegistryEntry,
+  getTypeDefault,
+  type RegistryEntry,
+} from './formBuilderRegistry'
+export {
+  useAppExperiment,
+  APP_EXPERIMENT_KEY,
+  type UseAppExperimentOptions,
+  type UseAppExperimentReturn,
+  type AppExperimentState,
+  type AppExperimentPopoverBinding,
+  type AppExperimentSelectorModalBinding,
+} from './useAppExperiment'
+export {
+  useExperimentSave,
+  type UseExperimentSaveOptions,
+  type UseExperimentSaveReturn,
+} from './useExperimentSave'
+export {
+  useTemplateCollection,
+  type TemplateCollectionInput,
+  type UseTemplateCollectionOptions,
+  type UseTemplateCollectionReturn,
+} from './useTemplateCollection'
+export {
+  useRequestSyncState,
+  type RequestSyncRunOptions,
+  type RequestSyncSuccessKind,
+  type UseRequestSyncStateReturn,
+} from './useRequestSyncState'
+export {
+  useCommandHistory,
+  type CommandHistoryCommand,
+  type CommandHistoryExecuteOptions,
+  type CommandHistoryResult,
+  type UseCommandHistoryOptions,
+  type UseCommandHistoryReturn,
+} from './useCommandHistory'
+export {
+  useOptimisticMutation,
+  type OptimisticMutationContext,
+  type UseOptimisticMutationOptions,
+  type UseOptimisticMutationReturn,
+} from './useOptimisticMutation'
+export {
+  createPluginResourceClient,
+  useResourceCrud,
+  type PluginResourceClientOptions,
+  type ResourceCrudAdapter,
+  type ResourceKey,
+  type UseResourceCrudOptions,
+  type UseResourceCrudReturn,
+} from './useResourceCrud'
+export {
+  detectDelimiter,
+  parseDelimitedText,
+  readFileAsText,
+  useFileImport,
+  validateImportFile,
+  type DelimitedTable,
+  type FileImportOptions,
+  type FileImportValidationOptions,
+  type ParseDelimitedTextOptions,
+  type UseFileImportReturn,
+} from './useFileImport'
+export {
+  useSelectionLimit,
+  type SelectionLimitSource,
+  type UseSelectionLimitOptions,
+  type UseSelectionLimitReturn,
+} from './useSelectionLimit'
+export {
+  useListSelection,
+  type ListSelectionSource,
+  type ListSelectionValue,
+  type UseListSelectionOptions,
+  type UseListSelectionReturn,
+  type WidenListSelectionValue,
+} from './useListSelection'
+export {
+  useGroupAssignment,
+  type GroupAssignmentSource,
+  type GroupAssignmentState,
+  type GroupAssignmentZone,
+  type UseGroupAssignmentOptions,
+  type UseGroupAssignmentReturn,
+} from './useGroupAssignment'
+export {
+  useSampleGroups,
+  type DisplaySampleSubGroup,
+  type SampleGroupNode,
+  type SampleGroupSource,
+  type SampleMajorGroup,
+  type UseSampleGroupsOptions,
+  type UseSampleGroupsReturn,
+} from './useSampleGroups'
+export {
+  useExpansionSet,
+  type ExpansionSetSource,
+  type UseExpansionSetOptions,
+  type UseExpansionSetReturn,
+} from './useExpansionSet'
+export {
+  compareSortValues,
+  useSortedItems,
+  type CompareSortValuesOptions,
+  type SortComparator,
+  type SortComparatorContext,
+  type SortDescriptor,
+  type SortedItemsSource,
+  type SortOrder,
+  type UseSortedItemsOptions,
+  type UseSortedItemsReturn,
+} from './useSortedItems'
+export {
+  candidateMatchesSearch,
+  normalizeSearchQuery,
+  useTextSearch,
+  type TextSearchCandidate,
+  type TextSearchSource,
+  type UseTextSearchOptions,
+  type UseTextSearchReturn,
+} from './useTextSearch'
+export {
+  coordinateToWellId,
+  useWellPainting,
+  wellIdToCoordinate,
+  wellIdsInRectangle,
+  type UseWellPaintingOptions,
+  type UseWellPaintingReturn,
+  type WellCoordinate,
+  type WellPaintResult,
+  type WellPlateSource,
+} from './useWellPainting'
+export {
+  createColumnConditions,
+  createRowConditions,
+  createWellPlateWells,
+  useWellPlateAdapter,
+  type AxisConditionEntry,
+  type UseWellPlateAdapterReturn,
+  type WellPlateAdapterOptions,
+  type WellPlateAdapterSource,
+  type WellPlateEntry,
+} from './useWellPlateAdapter'
+export {
+  runWellPlateValidation,
+  useWellPlateValidation,
+  type UseWellPlateValidationOptions,
+  type UseWellPlateValidationReturn,
+  type WellPlateValidationRule,
+  type WellPlateValidationSeverity,
+  type WellPlateValidationSource,
+  type WellPlateValidationWarning,
+} from './useWellPlateValidation'
+export {
+  controlsToFormSchema,
+  controlsToSectionFormSchema,
+  controlsToSectionFormSchemas,
+  controlsToSidebarPanels,
+  controlsToSettingsSchema,
+  controlsToTopBarSettingsConfig,
+  controlsToViewIds,
+  controlsToViewItems,
+  controlValuesToComponentBindings,
+  controlValuesToComponentBindingsById,
+  controlValuesToComponentProps,
+  defineControlComponentBindings,
+  defineControlModel,
+  defineDoseDesignControlModel,
+  defineDoseCalculatorControlProps,
+  defineControls,
+  defineWellPlateControlProps,
+  defineWellPlateDoseComponentBindings,
+  defineWellPlateDoseControlProps,
+  getDefaultControlView,
+  getControlDefaults,
+  useControlSchema,
+  useControlWorkspace,
+  type ControlDefinition,
+  type ControlComponentBinding,
+  type ControlComponentBindingConfig,
+  type ControlComponentBindingRecordConfig,
+  type ControlComponentBindingsById,
+  type ControlComponentBindingsConfig,
+  type ControlComponentPropSource,
+  type ControlComponentPropsByIdMap,
+  type ControlComponentPropsMap,
+  type DoseDesignControlModelOptions,
+  type DoseCalculatorControlPropsOptions,
+  type ControlFormSchema,
+  type ControlInput,
+  type ControlModel,
+  type ControlModelBinding,
+  type ControlModelSectionConfig,
+  type ControlModelViewConfig,
+  type ControlOption,
+  type ControlOptionValue,
+  type ControlPrimitive,
+  type ControlSchema,
+  type ControlSchemaOptions,
+  type ControlShorthand,
+  type ControlWorkspaceOptions,
+  type ControlFormBinding,
+  type ControlSettingsBinding,
+  type ControlSidebarBinding,
+  type ControlSectionConfig,
+  type ControlSidebarConfig,
+  type ControlTopBarSettingsBinding,
+  type ControlViewConfig,
+  type ControlValues,
+  type UseControlSchemaReturn,
+  type ControlWorkspaceAppTopBarPillBinding,
+  type ControlWorkspaceComponentBindings,
+  type ControlWorkspaceFormBinding,
+  type ControlWorkspacePillNavBinding,
+  type ControlWorkspaceSidebarBinding,
+  type ControlWorkspaceTopBarBinding,
+  type ControlWorkspaceTopBarSettingsBinding,
+  type UseControlWorkspaceReturn,
+  type WellPlateControlPropsOptions,
+  type WellPlateDoseControlPropsOptions,
+} from './useControlSchema'
+export {
+  getBioTemplateControlSchema,
+  requireBioTemplateControlSchema,
+  useBioTemplateControls,
+  type BioTemplateControlSchema,
+  type BioTemplateControlTarget,
+} from './useBioTemplateControls'
+export {
+  getBioTemplateComponentProps,
+  getBioTemplateComponentBindings,
+  toBioTemplateComponentBindings,
+  toBioTemplateComponentBindingsById,
+  toBioTemplateComponentProps,
+  toBioTemplateComponentPropsByComponent,
+  toBioTemplateComponentPropsById,
+  useBioTemplateComponents,
+  type BioTemplateComponentBinding,
+  type BioTemplateComponentBindingsById,
+  type BioTemplateComponentPropsByComponent,
+  type BioTemplateComponentPropsBinding,
+  type BioTemplateComponentPropsById,
+  type BioTemplateComponentPropsLookupOptions,
+  type BioTemplateResolvedComponentBinding,
+  type BioTemplateComponentTarget,
+  type UseBioTemplateComponentsReturn,
+} from './useBioTemplateComponents'
+export {
+  useBioTemplateWorkspace,
+  type BioTemplateRendererBinding,
+  type BioTemplateWorkspaceBindings,
+  type BioTemplateWorkspaceTarget,
+  type UseBioTemplateWorkspaceReturn,
+} from './useBioTemplateWorkspace'
+export {
+  useBioTemplatePresetWorkspace,
+  type BioTemplatePresetWorkspaceBindings,
+  type UseBioTemplatePresetWorkspaceOptions,
+  type UseBioTemplatePresetWorkspaceReturn,
+} from './useBioTemplatePresetWorkspace'
+export {
+  useBioTemplatePackWorkspace,
+  type UseBioTemplatePackWorkspaceOptions,
+  type UseBioTemplatePackWorkspaceReturn,
+} from './useBioTemplatePackWorkspace'
+export {
+  buildPluginEndpointUrl,
+  createPluginClient,
+  downloadBlob,
+  downloadPluginEndpoint,
+  getPluginPageSelectorItems,
+  pluginFormDataFromPayload,
+  resolvePluginBaseUrl,
+  uploadPluginEndpoint,
+  usePluginClient,
+  usePluginEventStream,
+  usePluginSettings,
+  useCurrentExperiment,
+  type BuildPluginEndpointUrlOptions,
+  type DownloadBlobOptions,
+  type DownloadPluginEndpointOptions,
+  type PluginContract,
+  type PluginContractSettings,
+  type PluginClientRequestOptions,
+  type PluginEndpointContract,
+  type PluginEndpointDefinition,
+  type PluginHttpMethod,
+  type PluginNavItemContract,
+  type PluginEndpointRequestOptions,
+  type PluginEventStreamMessage,
+  type PluginEventStreamOptions,
+  type PluginFormDataPayload,
+  type PluginFormDataValue,
+  type CreatePluginClientOptions,
+  type UseCurrentExperimentOptions,
+  type UseCurrentExperimentReturn,
+  type UsePluginEventStreamReturn,
+  type UsePluginSettingsOptions,
+  type UsePluginSettingsReturn,
+} from './usePluginClient'
+export {
+  combinePluginJobSources,
+  usePluginJobCenter,
+  useJobsStatusTray,
+  type CombinedPluginJobCenterSource,
+  type JobsStatusTrayAdapter,
+  type JobStreamMessage,
+  type PluginJobCenterSource,
+  type JobsStatusTrayTab,
+  type UseJobsStatusTrayOptions,
+  type UseJobsStatusTrayReturn,
+  type UsePluginJobCenterOptions,
+  type UsePluginJobCenterReturn,
+} from './useJobsStatusTray'

package/src/composables/platformContextHelpers.ts

@@ -0,0 +1,81 @@
+import type { PlatformContext } from '../types'
+
+export type ExperimentAwarePlatformContext = PlatformContext & {
+  currentExperiment?: unknown
+  currentExperimentId?: unknown
+  experiment?: unknown
+  experimentId?: unknown
+}
+
+export function getInjectedPlatformContext(): PlatformContext | undefined {
+  if (typeof window === 'undefined') return undefined
+  return (window as unknown as { __MINT_PLATFORM__?: PlatformContext }).__MINT_PLATFORM__
+}
+
+/** Return the platform's canonical plugin identity for the mounted frontend. */
+export function resolveCurrentPluginId(): string | undefined {
+  const pluginId = getInjectedPlatformContext()?.plugin?.id
+  return typeof pluginId === 'string' && pluginId ? pluginId : undefined
+}
+
+export function getInjectedExperimentContext(): ExperimentAwarePlatformContext | undefined {
+  return getInjectedPlatformContext() as ExperimentAwarePlatformContext | undefined
+}
+
+export function currentExperimentFromContext<TExperiment>(
+  context: ExperimentAwarePlatformContext | undefined = getInjectedExperimentContext(),
+): TExperiment | undefined {
+  const candidate = context?.currentExperiment ?? context?.experiment
+  return candidate && typeof candidate === 'object'
+    ? candidate as TExperiment
+    : undefined
+}
+
+export function currentExperimentIdFromContext(
+  context: ExperimentAwarePlatformContext | undefined = getInjectedExperimentContext(),
+): number | undefined {
+  return parseExperimentId(
+    context?.currentExperimentId ??
+    context?.experimentId ??
+    context?.currentExperiment ??
+    context?.experiment,
+  )
+}
+
+export function currentExperimentIdFromUrl(): number | undefined {
+  if (typeof window === 'undefined') return undefined
+  const location = window.location
+  const params = new URLSearchParams(location?.search ?? '')
+  return parseExperimentId(params.get('experimentId') ?? params.get('experiment_id'))
+    ?? experimentIdFromPath(location?.pathname ?? '')
+    ?? experimentIdFromPath((location?.hash ?? '').replace(/^#\/?/, '/'))
+}
+
+export function resolveCurrentExperimentId(
+  context: ExperimentAwarePlatformContext | undefined = getInjectedExperimentContext(),
+): number | undefined {
+  return currentExperimentIdFromContext(context) ?? currentExperimentIdFromUrl()
+}
+
+export function parseExperimentId(value: unknown): number | undefined {
+  if (typeof value === 'number' && Number.isFinite(value)) return value
+  if (typeof value === 'string' && value.trim()) {
+    const parsed = Number(value)
+    return Number.isFinite(parsed) ? parsed : undefined
+  }
+  if (value && typeof value === 'object' && 'id' in value) {
+    return parseExperimentId((value as { id?: unknown }).id)
+  }
+  return undefined
+}
+
+function experimentIdFromPath(path: string): number | undefined {
+  const segments = path.split('/').filter(Boolean)
+  for (let index = 0; index < segments.length - 1; index += 1) {
+    const segment = segments[index]?.toLowerCase()
+    if (segment === 'experiment' || segment === 'experiments') {
+      return parseExperimentId(decodeURIComponent(segments[index + 1] ?? ''))
+    }
+  }
+  return undefined
+}