@morscherlab/mint-sdk 1.3.11 → 1.4.0-beta.10

package/src/composables/index.ts

@@ -1,342 +1,23 @@
-export {
-  AuthenticationRequiredError,
-  useApi,
-  type ApiClientOptions,
-  type UseApiReturn,
-} from './useApi'
+// Package-root composables: the L1 and L2 names of spec 3.3. Subpath composables are
+// exported from `lab.ts`, `shell.ts`, `data.ts` and `runtime.ts`; `deprecatedRootExports.ts`
+// keeps the other 1.3 root names until MINT 1.5.
 export { useTheme } from './useTheme'
 export { useToast } from './useToast'
-export { usePlatformContext } from './usePlatformContext'
+export { usePlatform } from './usePlatform'
+export { useExperiment, type ExperimentLoadStatus, type UseExperimentReturn } from './useExperiment'
 export { resolvePluginFrontendBase } from './pluginFrontendBase'
+export { providePluginIdentity, type PluginIdentityContract } from './pluginIdentity'
 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 {
-  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,
-  type PlateEditorListeners,
-} from './useRackEditor'
-export {
-  useChemicalFormula,
-  ATOMIC_WEIGHTS,
-  type ParsedElement,
-  type FormulaParseResult,
-  type FormulaPart,
-  type FormulaPartType,
-} from './useChemicalFormula'
-export {
-  useSequenceUtils,
-  type SequenceType,
-  type SequenceStats,
-  type SequenceProblems,
-} 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 {
-  resizedLeadingPanelWidth,
-  resizedTrailingPanelWidth,
-  resizedVerticalSplitPercent,
-  useManualLayoutResize,
-  type ManualLayoutResizeContext,
-  type ManualLayoutResizeTarget,
-  type ResizePanelWidthConstraints,
-  type ResizePercentConstraints,
-} from './useManualLayoutResize'
-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 {
-  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 {
-  useFileBrowser,
-  type UseFileBrowserOptions,
-  type UseFileBrowserReturn,
-} from './useFileBrowser'
-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'
+  useRequest,
+  type RequestKind,
+  type RequestOperation,
+  type RequestRunOptions,
+  type UseRequestReturn,
+} from './useRequest'
+export { downloadBlob, type DownloadBlobOptions } from './createClient'
+// The control model types: the input and output of `defineControlModel`.
 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 {
-  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 {
-  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,
@@ -346,9 +27,6 @@ export {
   type ControlComponentPropSource,
   type ControlComponentPropsByIdMap,
   type ControlComponentPropsMap,
-  type DoseDesignControlModelOptions,
-  type DoseCalculatorControlPropsOptions,
-  type ControlFormSchema,
   type ControlInput,
   type ControlModel,
   type ControlModelBinding,
@@ -361,156 +39,15 @@ export {
   type ControlSchemaOptions,
   type ControlShorthand,
   type ControlWorkspaceOptions,
-  type ControlFormBinding,
-  type ControlSettingsBinding,
-  type ControlSidebarBinding,
+  type ControlFormActions,
   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'
-export {
-  usePluginWorkspace,
-  type PluginWorkspaceSlotsLike,
-  type UsePluginWorkspaceOptions,
-  type UsePluginWorkspaceReturn,
-} from './usePluginWorkspace'
+export { defineDataFrame, definePluginWorkspaceView } from './componentSpecs'
+// The slot payloads of `PluginWorkspaceView`.
 export {
   type PluginWorkspaceControlsModel,
   type PluginWorkspaceShellModel,
   type PluginWorkspaceSidebarModel,
 } from './pluginWorkspaceModel'
-export {
-  useFocusTrap,
-  type UseFocusTrapOptions,
-  type UseFocusTrapReturn,
-} from './useFocusTrap'
-export {
-  useRovingFocus,
-  type UseRovingFocusOptions,
-  type UseRovingFocusReturn,
-} from './useRovingFocus'
-export {
-  reorderList,
-  useListReorder,
-  useReorderAnnouncer,
-  REORDER_ANNOUNCER_STYLE,
-  type ListReorderMove,
-  type UseListReorderOptions,
-  type UseListReorderReturn,
-  type UseReorderAnnouncerReturn,
-} from './useListReorder'
-export {
-  useMenuKeyboard,
-  type UseMenuKeyboardOptions,
-  type UseMenuKeyboardReturn,
-} from './useMenuKeyboard'
-
-export { usePlatformFilePickerAdapter, encodePlatformPickerPath, decodePlatformPickerPath } from './usePlatformFilePickerAdapter'
-export { createFilePickerAdapter } from './createFilePickerAdapter'
-export type { FilePickerTransport, FilePickerAdapterOptions } from './createFilePickerAdapter'

package/src/composables/platformContextHelpers.ts

@@ -1,12 +1,5 @@
 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__
@@ -18,45 +11,6 @@ export function resolveCurrentPluginId(): string | undefined {
   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()) {
@@ -68,14 +22,3 @@ export function parseExperimentId(value: unknown): number | undefined {
   }
   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
-}

package/src/composables/pluginEndpointBuilder.ts

@@ -1,13 +1,11 @@
-import {
-  getInjectedPlatformContext,
-  resolveCurrentExperimentId,
-} from './platformContextHelpers'
+import { getInjectedPlatformContext } from './platformContextHelpers'
+import { useExperimentStore } from '../stores/experiment'
 import type {
-  BuildPluginEndpointUrlOptions,
+  BuildEndpointUrlOptions,
   PluginContract,
   PluginEndpointDefinition,
   PluginEndpointParamDefinition,
-} from './usePluginClient'
+} from './createClient'
 
 function normalizeApiBaseUrl(baseUrl: string | undefined): string | undefined {
   if (!baseUrl) return undefined
@@ -94,8 +92,8 @@ function withDefaultPathParams(
       continue
     }
     if (isExperimentPathParam(fieldName) || isExperimentPathParam(name)) {
-      const experimentId = resolveCurrentExperimentId()
-      if (experimentId !== undefined) {
+      const experimentId = useExperimentStore().currentId
+      if (experimentId !== null) {
         nextPayload[fieldName] = experimentId
       }
     }
@@ -254,11 +252,11 @@ function joinBaseUrl(baseUrl: string, path: string): string {
 }
 
 /** Build the concrete URL for a generated plugin endpoint without making a request. */
-export function buildPluginEndpointUrl(
+export function buildEndpointUrl(
   contract: PluginContract,
   endpoint: PluginEndpointDefinition,
   payload?: unknown,
-  options: BuildPluginEndpointUrlOptions = {},
+  options: BuildEndpointUrlOptions = {},
 ): string {
   const parts = pluginEndpointRequestParts(contract, endpoint, payload, options.baseUrl)
   const pathWithQuery = `${parts.path}${queryString(parts.query)}`

package/src/composables/pluginIdentity.ts

@@ -0,0 +1,31 @@
+import { reactive, readonly } from 'vue'
+import type { PluginContract } from './createClient'
+
+/** The `plugin` block of the generated contract (`./generated/mint-plugin`) that `providePluginIdentity` reads. */
+export interface PluginIdentityContract {
+  plugin: Pick<PluginContract['plugin'], 'name' | 'displayName' | 'subtitle' | 'description' | 'icon'>
+}
+
+const identity = reactive<{ name?: string; subtitle?: string; icon?: string }>({})
+
+/** The seeded identity AppTopBar shows in standalone mode. Internal: not exported from the package. */
+export const pluginIdentity = readonly(identity)
+
+/**
+ * Seed the standalone AppTopBar with the plugin name, subtitle and icon. In integrated
+ * mode the platform supplies them. Explicit `title`/`subtitle` props and the `#icon` slot still win.
+ *
+ * @example
+ * ```typescript
+ * import { providePluginIdentity } from '@morscherlab/mint-sdk'
+ * import { contract } from './generated/mint-plugin'
+ *
+ * providePluginIdentity(contract)
+ * ```
+ */
+export function providePluginIdentity(contract: PluginIdentityContract): void {
+  const { plugin } = contract
+  identity.name = plugin.displayName || plugin.name || undefined
+  identity.subtitle = plugin.subtitle || plugin.description || undefined
+  identity.icon = plugin.icon || undefined
+}