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

package/src/composables/usePluginClient.ts

@@ -15,6 +15,7 @@ import {
 import { usePlatformContext } from './usePlatformContext'
 import { useRequestSyncState } from './useRequestSyncState'
 import { useAuthStore } from '../stores/auth'
+import { PLUGIN_SECRET_FORMAT_KEY } from '../utils/pluginSecrets'
 import {
   currentExperimentFromContext,
   getInjectedPlatformContext,
@@ -545,6 +546,26 @@ export function usePluginClient<TClient>(client: TClient): TClient {
 
 const PLATFORM_OWNED_SETTINGS_KEY = 'allowed_experiment_types'
 
+/**
+ * Secret settings travel as `{ "$secret": "<id>" }` references, so an untouched
+ * secret round-trips without ever exposing its value. Declaring the format on
+ * every write keeps a `null` unambiguous: it clears the stored secret instead of
+ * meaning "unchanged", which is what the deprecated placeholder form meant.
+ */
+function withSecretFormat(
+  payload: Record<string, unknown>,
+  secretFormat: string | null,
+): Record<string, unknown> {
+  if (!secretFormat) return payload
+  return { ...payload, [PLUGIN_SECRET_FORMAT_KEY]: secretFormat }
+}
+
+function responseSecretFormat(response: unknown): string | null {
+  if (!response || typeof response !== 'object') return null
+  const format = (response as Record<string, unknown>)[PLUGIN_SECRET_FORMAT_KEY]
+  return typeof format === 'string' && format ? format : null
+}
+
 function cloneRecord(value: Record<string, unknown>): Record<string, unknown> {
   return JSON.parse(JSON.stringify(value)) as Record<string, unknown>
 }
@@ -618,6 +639,7 @@ export function usePluginSettings<TSettings = Record<string, unknown>>(
   const values = ref({}) as Ref<PluginSettingsValues<TSettings>>
   const savedValues = shallowRef<Record<string, unknown>>({})
   const revision = ref<string | null>(null)
+  const secretFormat = ref<string | null>(null)
   const request = useRequestSyncState('Plugin settings request failed.')
   const isLoading = ref(false)
   const isSaving = ref(false)
@@ -650,11 +672,16 @@ export function usePluginSettings<TSettings = Record<string, unknown>>(
     values.value = cloneRecord(nextValues) as PluginSettingsValues<TSettings>
   }
 
-  function applyLoaded(nextValues: Record<string, unknown>, nextRevision: string | null): void {
+  function applyLoaded(
+    nextValues: Record<string, unknown>,
+    nextRevision: string | null,
+    nextSecretFormat: string | null = secretFormat.value,
+  ): void {
     const cloned = cloneRecord(nextValues)
     values.value = cloned as PluginSettingsValues<TSettings>
     savedValues.value = cloneRecord(cloned)
     revision.value = nextRevision
+    secretFormat.value = nextSecretFormat
   }
 
   async function load(): Promise<void> {
@@ -674,6 +701,7 @@ export function usePluginSettings<TSettings = Record<string, unknown>>(
       applyLoaded(
         responseSettingsPayload(response),
         responseSettingsRevision(response),
+        responseSecretFormat(response),
       )
     } catch {
       // Error state is handled by request.run().
@@ -707,7 +735,12 @@ export function usePluginSettings<TSettings = Record<string, unknown>>(
               revision?: string
             }>(
               `/plugins/${encodeURIComponent(resolvedPluginName.value)}/config`,
-              { config: topLevelSettingsPatch(payload, typedKeys) },
+              {
+                config: withSecretFormat(
+                  topLevelSettingsPatch(payload, typedKeys),
+                  secretFormat.value,
+                ),
+              },
             ),
             { success: 'save', errorMessage: 'Failed to save plugin settings' },
           )
@@ -730,7 +763,11 @@ export function usePluginSettings<TSettings = Record<string, unknown>>(
         }
 
         if (!response) return true
-        applyLoaded(responseSettingsPayload(response), nextRevision)
+        applyLoaded(
+          responseSettingsPayload(response),
+          nextRevision,
+          responseSecretFormat(response) ?? secretFormat.value,
+        )
         return true
       } else {
         const ifMatch = revision.value
@@ -741,13 +778,14 @@ export function usePluginSettings<TSettings = Record<string, unknown>>(
             settings: Record<string, unknown>
             mode?: string
             revision?: string
-          }>('/settings', payload, ifMatch),
+          }>('/settings', withSecretFormat(payload, secretFormat.value), ifMatch),
           { success: 'save', errorMessage: 'Failed to save plugin settings' },
         )
       }
       applyLoaded(
         responseSettingsPayload(response),
         responseSettingsRevision(response) ?? revision.value,
+        responseSecretFormat(response) ?? secretFormat.value,
       )
       return true
     } catch {

package/src/composables/usePluginWorkspace.ts

@@ -0,0 +1,208 @@
+import { computed } from 'vue'
+import type { ComputedRef } from 'vue'
+import type { PageSelectorItem, PillNavItem } from '../types'
+import type {
+  PluginWorkspaceViewEmit,
+  PluginWorkspaceViewProps,
+} from '../components/PluginWorkspaceView.props'
+import { usePluginWorkspaceControls } from '../components/PluginWorkspaceView.controls'
+import { usePluginWorkspaceNavigation } from '../components/PluginWorkspaceView.navigation'
+import {
+  getPluginWorkspaceSidebarSlotNames,
+  getPluginWorkspaceTopBarSlotNames,
+  hasPluginWorkspaceSidebarSurface,
+} from '../components/PluginWorkspaceView.shell'
+import type {
+  PluginWorkspaceControlsModel,
+  PluginWorkspaceShellModel,
+  PluginWorkspaceSidebarModel,
+} from './pluginWorkspaceModel'
+
+/**
+ * Loosely-typed view of a component's `useSlots()` result: only slot presence and names are
+ * read here, so this accepts any `defineSlots()` shape without fighting Vue's `Slot` render
+ * function type. Mirrors the `SlotKeyMap` helper type in PluginWorkspaceView.shell.ts.
+ */
+export type PluginWorkspaceSlotsLike = Readonly<Record<string, unknown>>
+
+export interface UsePluginWorkspaceOptions {
+  /** PluginWorkspaceView's own reactive props object (from `defineProps`). */
+  props: PluginWorkspaceViewProps
+  /** PluginWorkspaceView's own slots (from `useSlots()`), used to detect provided passthrough slots. */
+  slots: PluginWorkspaceSlotsLike
+  /** PluginWorkspaceView's own typed `emit` function (from `defineEmits<PluginWorkspaceViewEmits>()`). */
+  emit: PluginWorkspaceViewEmit
+}
+
+export interface UsePluginWorkspaceReturn {
+  /** Model consumed by WorkspaceShellInternal's `shell` prop. */
+  shell: ComputedRef<PluginWorkspaceShellModel>
+  /** Model consumed by WorkspaceSidebarInternal's `sidebar` prop. */
+  sidebar: ComputedRef<PluginWorkspaceSidebarModel>
+  /** Model consumed by WorkspaceControlsInternal's `controls` prop, and by the raw `default` slot. */
+  controls: ComputedRef<PluginWorkspaceControlsModel>
+  /** Whether AppLayout should render a sidebar surface at all. */
+  hasSidebarSurface: ComputedRef<boolean>
+  /** Applies an AppSidebar `update:model-value` payload to the shared control values and emits `update:modelValue`/`update:values`. */
+  handleControlValuesUpdate: (values: Record<string, unknown>) => void
+  /** Resolves an AppTopBar `page-selector-select` payload into the active view and emits `page-selector-select`. */
+  handlePageSelectorSelect: (page: PageSelectorItem) => void
+  /** Resolves an AppTopBar `pill-select` payload into the active view and emits `pill-select`. */
+  handlePillSelect: (item: PillNavItem) => void
+}
+
+/**
+ * Maps PluginWorkspaceView's flat 72-prop surface into the three typed model objects
+ * (`shell`, `sidebar`, `controls`) rendered by its internal pieces
+ * (WorkspaceShellInternal, WorkspaceSidebarInternal, WorkspaceControlsInternal). Reuses the
+ * existing `usePluginWorkspaceControls` / `usePluginWorkspaceNavigation` composables and the
+ * PluginWorkspaceView.shell slot-detection helpers, so it changes only how that state is
+ * assembled and exposed, not the underlying behavior.
+ *
+ * @example Recommended
+ * ```ts
+ * const props = withDefaults(defineProps<PluginWorkspaceViewProps>(), { ... })
+ * const emit = defineEmits<PluginWorkspaceViewEmits>()
+ * const slots = useSlots()
+ * const { shell, sidebar, controls } = usePluginWorkspace({ props, slots, emit })
+ * ```
+ */
+export function usePluginWorkspace(options: UsePluginWorkspaceOptions): UsePluginWorkspaceReturn {
+  const { props, slots, emit } = options
+
+  const controlsState = usePluginWorkspaceControls({
+    model: () => props.model,
+    controls: () => props.controls,
+    controlOptions: () => props.controlOptions ?? {},
+    modelValue: () => props.modelValue,
+    values: () => props.values,
+    componentBindings: () => props.componentBindings,
+    componentProps: () => props.componentProps,
+    componentPropsById: () => props.componentPropsById,
+    emitValues: (values) => {
+      emit('update:modelValue', values)
+      emit('update:values', values)
+    },
+  })
+
+  const navigationState = usePluginWorkspaceNavigation({
+    activeView: () => props.activeView,
+    defaultActiveView: () => props.defaultActiveView,
+    currentPillId: () => props.currentPillId,
+    currentPageSelectorId: () => props.currentPageSelectorId,
+    pillNav: () => props.pillNav,
+    pageSelector: () => props.pageSelector,
+    panelIds: () => Object.keys(props.panels ?? {}),
+    generatedPillNav: controlsState.generatedPillNav,
+    generatedDefaultView: controlsState.generatedDefaultView,
+    emitActiveView: viewId => emit('update:activeView', viewId),
+    emitPageSelectorSelect: page => emit('page-selector-select', page),
+    emitPillSelect: item => emit('pill-select', item),
+  })
+
+  const topBarSlotNames = computed<string[]>(() => getPluginWorkspaceTopBarSlotNames(slots))
+  const sidebarSlotNames = computed<string[]>(() => getPluginWorkspaceSidebarSlotNames(slots))
+
+  const hasSidebarSurface = computed(() => hasPluginWorkspaceSidebarSurface({
+    showSidebar: props.showSidebar ?? true,
+    panels: props.panels ?? {},
+    forms: props.forms ?? {},
+    model: props.model,
+    controls: props.controls,
+    showSidebarWhenEmpty: props.showSidebarWhenEmpty ?? false,
+    sidebarContentId: props.sidebarContentId,
+    sidebarTitle: props.sidebarTitle,
+    sidebarSubtitle: props.sidebarSubtitle,
+    sidebarBadge: props.sidebarBadge,
+    hasSidebarSlot: Boolean(slots.sidebar),
+    sidebarSlotCount: sidebarSlotNames.value.length,
+  }))
+
+  const controls = computed<PluginWorkspaceControlsModel>(() => ({
+    activeView: navigationState.resolvedActiveView.value,
+    setActiveView: navigationState.setActiveView,
+    values: controlsState.internalControlValues,
+    componentBindings: controlsState.resolvedComponentBindings.value,
+    componentBindingsById: controlsState.resolvedComponentBindingsById.value,
+    componentProps: controlsState.resolvedComponentProps.value,
+    componentPropsById: controlsState.resolvedComponentPropsById.value,
+  }))
+
+  const shell = computed<PluginWorkspaceShellModel>(() => ({
+    sidebarPosition: props.sidebarPosition ?? 'left',
+    sidebarWidth: props.sidebarWidth,
+    floating: props.floating ?? true,
+    responsiveSidebar: props.responsiveSidebar ?? true,
+    sidebarToggleLabel: props.sidebarToggleLabel ?? 'Open workspace sidebar',
+    sidebarCloseLabel: props.sidebarCloseLabel ?? 'Close workspace sidebar',
+    hasSidebarSurface: hasSidebarSurface.value,
+    title: props.title ?? 'Workspace',
+    subtitle: props.subtitle,
+    topBarVariant: props.topBarVariant ?? 'card',
+    homePath: props.homePath ?? '/',
+    showLogo: props.showLogo ?? true,
+    pageSelector: props.pageSelector,
+    currentPageSelectorId: navigationState.resolvedCurrentPageSelectorId.value,
+    pluginSwitcher: props.pluginSwitcher,
+    pillNav: navigationState.resolvedPillNav.value,
+    currentPillId: navigationState.resolvedCurrentPillId.value,
+    showThemeToggle: props.showThemeToggle ?? true,
+    showSettings: props.showSettings ?? true,
+    settingsConfig: props.settingsConfig,
+    showStandaloneLabel: props.showStandaloneLabel ?? false,
+    standaloneLabel: props.standaloneLabel ?? 'Standalone',
+    accountMenu: props.accountMenu,
+    showNotifications: props.showNotifications ?? false,
+    hasNotificationDot: props.hasNotificationDot ?? false,
+    showAdmin: props.showAdmin ?? false,
+    adminPath: props.adminPath ?? '/admin',
+    userName: props.userName,
+    userInitial: props.userInitial,
+    userEmail: props.userEmail,
+    topBarSlotNames: topBarSlotNames.value,
+    controls: controls.value,
+  }))
+
+  const sidebar = computed<PluginWorkspaceSidebarModel>(() => ({
+    title: props.sidebarTitle,
+    subtitle: props.sidebarSubtitle,
+    badge: props.sidebarBadge,
+    variant: props.sidebarVariant ?? 'analysis',
+    panels: props.panels ?? {},
+    activeView: navigationState.resolvedActiveView.value,
+    floating: false,
+    dense: props.dense ?? true,
+    width: props.sidebarWidth,
+    side: props.sidebarPosition ?? 'left',
+    forms: props.forms ?? {},
+    contentId: props.sidebarContentId,
+    showWhenEmpty: (props.showSidebarWhenEmpty ?? false) || props.sidebarContentId !== undefined,
+    model: props.model,
+    controlSchema: props.controls,
+    controlOptions: props.controlOptions ?? {},
+    values: controlsState.internalControlValues,
+    formEnhancements: props.formEnhancements,
+    showFormActions: props.showFormActions ?? false,
+    formLoading: props.formLoading ?? false,
+    formDisabled: props.formDisabled ?? false,
+    formReadonly: props.formReadonly ?? false,
+    formSize: props.formSize ?? 'sm',
+    collapsible: props.sidebarCollapsible,
+    collapsed: props.sidebarCollapsed,
+    defaultCollapsed: props.defaultSidebarCollapsed ?? false,
+    collapsedWidth: props.sidebarCollapsedWidth ?? '3rem',
+    collapseButtonLabel: props.sidebarCollapseButtonLabel ?? 'Collapse sidebar',
+    expandButtonLabel: props.sidebarExpandButtonLabel ?? 'Expand sidebar',
+    slotNames: sidebarSlotNames.value,
+  }))
+
+  return {
+    shell,
+    sidebar,
+    controls,
+    hasSidebarSurface,
+    handleControlValuesUpdate: controlsState.handleControlValuesUpdate,
+    handlePageSelectorSelect: navigationState.handlePageSelectorSelect,
+    handlePillSelect: navigationState.handlePillSelect,
+  }
+}

package/src/composables/useResourceCrud.ts

@@ -38,7 +38,11 @@ export interface UseResourceCrudReturn<TItem, TCreate, TUpdate, TKey extends Res
   clearError: () => void
 }
 
-/** Common list/create/update/delete state wrapper for generated plugin clients. */
+/**
+ * Common list/create/update/delete state wrapper for generated plugin clients.
+ *
+ * @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useGeneratedPluginClient()` instead.
+ */
 export function useResourceCrud<
   TItem,
   TCreate = Partial<TItem>,

package/src/composables/useRovingFocus.ts

@@ -0,0 +1,66 @@
+import { nextTick } from 'vue'
+
+export interface UseRovingFocusOptions {
+  /** Selectable item ids, in DOM order. Already excludes items skipped entirely (e.g. disabled tabs). */
+  ids: () => string[]
+  /** The id that is currently active/selected. */
+  activeId: () => string | undefined
+  /** Activates an id (e.g. emit `update:modelValue`). The composable focuses the matching element afterward. */
+  activate: (id: string) => void
+  /** Returns the focusable element for an id, queried lazily so it reflects the post-activation DOM. */
+  getElement: (id: string) => HTMLElement | null | undefined
+  /** Arrow-key axis: `'horizontal'` (Left/Right, default) or `'vertical'` (Up/Down). */
+  orientation?: 'horizontal' | 'vertical'
+}
+
+export interface UseRovingFocusReturn {
+  /** Bind to each item's `@keydown`. */
+  handleKeydown: (event: KeyboardEvent) => void
+}
+
+/**
+ * WAI-ARIA roving-tabindex navigation with automatic activation (the tabs pattern):
+ * Left/Right (or Up/Down when `orientation` is `'vertical'`) move to the adjacent item
+ * and activate it immediately, wrapping past the ends; Home/End jump to the first/last
+ * item. Only the active item should carry `tabindex="0"`; give every other item
+ * `tabindex="-1"`. Used by BaseTabs.
+ */
+export function useRovingFocus(options: UseRovingFocusOptions): UseRovingFocusReturn {
+  const orientation = options.orientation ?? 'horizontal'
+  const prevKey = orientation === 'vertical' ? 'ArrowUp' : 'ArrowLeft'
+  const nextKey = orientation === 'vertical' ? 'ArrowDown' : 'ArrowRight'
+
+  function moveTo(id: string | undefined) {
+    if (id === undefined) return
+    options.activate(id)
+    void nextTick(() => options.getElement(id)?.focus())
+  }
+
+  function handleKeydown(event: KeyboardEvent) {
+    const ids = options.ids()
+    if (ids.length === 0) return
+    const currentIndex = ids.indexOf(options.activeId() ?? '')
+
+    if (event.key === 'Home') {
+      event.preventDefault()
+      moveTo(ids[0])
+      return
+    }
+    if (event.key === 'End') {
+      event.preventDefault()
+      moveTo(ids[ids.length - 1])
+      return
+    }
+    if (event.key === prevKey) {
+      event.preventDefault()
+      moveTo(ids[currentIndex <= 0 ? ids.length - 1 : currentIndex - 1])
+      return
+    }
+    if (event.key === nextKey) {
+      event.preventDefault()
+      moveTo(ids[currentIndex === -1 || currentIndex >= ids.length - 1 ? 0 : currentIndex + 1])
+    }
+  }
+
+  return { handleKeydown }
+}

package/src/composables/useWellPainting.ts

@@ -46,7 +46,11 @@ const PLATE_DIMENSIONS: Record<WellPlateFormat, { rows: number; cols: number }>
   384: { rows: 16, cols: 24 },
 }
 
-/** Pointer painting/rectangle selection state for WellPlate-based editors. */
+/**
+ * Pointer painting/rectangle selection state for WellPlate-based editors.
+ *
+ * @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useWellPlateEditor()` instead.
+ */
 export function useWellPainting<TMode extends string = string, TPayload = unknown>(
   options: UseWellPaintingOptions<TMode, TPayload>,
 ): UseWellPaintingReturn<TMode, TPayload> {

package/src/composables/useWellPlateAdapter.ts

@@ -28,7 +28,11 @@ export interface UseWellPlateAdapterReturn {
   wells: ComputedRef<Record<string, Partial<Well>>>
 }
 
-/** Convert domain rows into WellPlate's wells prop without hand-written adapters. */
+/**
+ * Convert domain rows into WellPlate's wells prop without hand-written adapters.
+ *
+ * @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useWellPlateEditor()` instead.
+ */
 export function useWellPlateAdapter<TEntry>(
   options: WellPlateAdapterOptions<TEntry>,
 ): UseWellPlateAdapterReturn {

package/src/composables/useWellPlateValidation.ts

@@ -33,7 +33,11 @@ export interface UseWellPlateValidationReturn<TType extends string = string> {
   errorCount: ComputedRef<number>
 }
 
-/** Rule-driven validation state for WellPlate layout/design screens. */
+/**
+ * Rule-driven validation state for WellPlate layout/design screens.
+ *
+ * @deprecated Unused by the MINT platform and scheduled for removal in MINT 1.3; use `useWellPlateEditor()` instead.
+ */
 export function useWellPlateValidation<TContext, TType extends string = string>(
   options: UseWellPlateValidationOptions<TContext, TType>,
 ): UseWellPlateValidationReturn<TType> {