@morscherlab/mint-sdk 1.1.0-beta.5 → 1.1.0-beta.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@morscherlab/mint-sdk",
-  "version": "1.1.0-beta.5",
+  "version": "1.1.0-beta.7",
   "description": "MINT Platform SDK — Vue 3 components, composables, and types for plugin development. MINT = Mass-spec INtegrated Toolkit.",
   "type": "module",
   "main": "./dist/index.js",

package/src/__tests__/components/GeneratedPluginView.test.ts

@@ -190,6 +190,16 @@ describe('GeneratedPluginView', () => {
     expect(wrapper.find('[aria-label="Job resource requirements"]').text()).toBe('Host service')
   })
 
+  it('describes process CPU declarations as an upper bound', async () => {
+    const wrapper = mount(GeneratedPluginView, {
+      props: { baseUrl: '/api/demo' },
+      global: { plugins: [createPinia()], stubs: { 'router-link': true, Teleport: true } },
+    })
+    await flushPromises()
+
+    expect(wrapper.find('[aria-label="Job resource requirements"]').text()).toBe('Up to 2 CPU')
+  })
+
   it('should pass the host transport to the generated analysis composable', async () => {
     const transport = vi.fn()
     mount(GeneratedPluginView, {

package/src/__tests__/components/PluginWorkspaceView.test.ts

@@ -1,4 +1,5 @@
 import { flushPromises, mount } from '@vue/test-utils'
+import type { VueWrapper } from '@vue/test-utils'
 import { createPinia } from 'pinia'
 import { computed, h, nextTick, ref } from 'vue'
 import { describe, expect, it, vi } from 'vitest'
@@ -10,7 +11,7 @@ import ExperimentSelectorModal from '../../components/ExperimentSelectorModal.vu
 import PluginWorkspaceView from '../../components/PluginWorkspaceView.vue'
 import { defineDoseDesignControlModel } from '../../composables/useControlSchema'
 import { usePlatformContext } from '../../composables/usePlatformContext'
-import type { PillNavItem, SidebarToolSection } from '../../types'
+import type { PageSelectorItemInput, PillNavItem, SidebarToolSection } from '../../types'
 
 vi.mock('../../composables/usePlatformContext', () => ({
   usePlatformContext: vi.fn(() => ({
@@ -79,6 +80,44 @@ const globalOptions = {
   },
 }
 
+interface PageSelectorWorkspaceProps {
+  pageSelector?: PageSelectorItemInput[]
+  currentPageSelectorId?: string
+}
+
+function mountIntegratedPageSelectorWorkspace(
+  props: PageSelectorWorkspaceProps = {},
+): VueWrapper {
+  vi.mocked(usePlatformContext).mockReturnValueOnce({
+    isIntegrated: computed(() => true),
+    context: ref({ isIntegrated: true, theme: 'system' }),
+    plugin: computed(() => ({
+      id: 'workspace-plugin',
+      name: 'Workspace Plugin',
+      version: '1.0.0',
+      route_prefix: '/workspace-plugin',
+      api_prefix: '/api/workspace-plugin',
+      nav_items: [
+        { path: '/platform-one', label: 'Platform One' },
+        { path: '/platform-two', label: 'Platform Two' },
+      ],
+    })),
+    user: computed(() => undefined),
+    theme: computed(() => 'system' as const),
+    features: computed(() => undefined),
+    navigate: vi.fn(),
+    notify: vi.fn(),
+    sendToPlatform: vi.fn(),
+  })
+  return mount(PluginWorkspaceView, {
+    props: {
+      title: 'Workspace',
+      ...props,
+    },
+    global: globalOptions,
+  })
+}
+
 describe('PluginWorkspaceView', () => {
   it('renders the standard AppLayout, AppTopBar, and AppSidebar plugin shell', () => {
     const wrapper = mount(PluginWorkspaceView, {
@@ -146,22 +185,37 @@ describe('PluginWorkspaceView', () => {
     expect(wrapper.emitted('pill-select')).toEqual([[{ id: 'results', label: 'Results' }]])
   })
 
-  it('hides topbar page selector until multiple pages are registered', () => {
-    const wrapper = mount(PluginWorkspaceView, {
-      props: {
-        title: 'Downloader',
-        subtitle: 'Downloads',
-        pageSelector: [
-          { id: 'downloads', label: 'Downloads', to: '/' },
-        ],
-        currentPageSelectorId: 'downloads',
-      },
-      global: globalOptions,
+  it('should use platform pages when pageSelector is omitted', () => {
+    const wrapper = mountIntegratedPageSelectorWorkspace()
+
+    expect(wrapper.find('.mint-page-selector').exists()).toBe(true)
+  })
+
+  it('should suppress platform pages when pageSelector is explicitly empty', () => {
+    const wrapper = mountIntegratedPageSelectorWorkspace({ pageSelector: [] })
+
+    expect(wrapper.find('.mint-page-selector').exists()).toBe(false)
+  })
+
+  it('should hide one explicit page without falling back to platform pages', () => {
+    const wrapper = mountIntegratedPageSelectorWorkspace({
+      pageSelector: [{ id: 'downloads', label: 'Downloads', to: '/' }],
+      currentPageSelectorId: 'downloads',
     })
 
-    expect(wrapper.findComponent(AppTopBar).props('pageSelector')).toBeUndefined()
     expect(wrapper.find('.mint-page-selector').exists()).toBe(false)
-    expect(wrapper.find('.mint-topbar-title-group').text()).toContain('Downloader')
+  })
+
+  it('should render multiple explicit pages ahead of platform pages', () => {
+    const wrapper = mountIntegratedPageSelectorWorkspace({
+      pageSelector: [
+        { id: 'overview', label: 'Overview', to: '/' },
+        { id: 'reports', label: 'Reports', to: '/reports' },
+      ],
+      currentPageSelectorId: 'overview',
+    })
+
+    expect(wrapper.get('.mint-page-selector__label').text()).toBe('Overview')
   })
 
   it('passes compact control models to the sidebar for generated forms', () => {

package/src/__tests__/composables/useGeneratedAnalysis.test.ts

@@ -407,6 +407,7 @@ describe('useGeneratedAnalysis', () => {
         uploadUrl: upload?.[0],
         uploadMethod: upload?.[1]?.method,
         uploadSessionHeader: new Headers(upload?.[1]?.headers).get('X-Mint-Job-Session'),
+        uploadDefinitionHeader: new Headers(upload?.[1]?.headers).get('X-Mint-Job-Definition'),
         sessionId: form.get('session_id'),
         relativePaths: form.getAll('relative_paths'),
         submittedSource: submit.inputs.source,
@@ -414,6 +415,7 @@ describe('useGeneratedAnalysis', () => {
         uploadUrl: '/api/demo/jobs/uploads',
         uploadMethod: 'POST',
         uploadSessionHeader: 'session-1',
+        uploadDefinitionHeader: 'run',
         sessionId: 'session-1',
         relativePaths: ['data.csv'],
         submittedSource: { token: 'upload-token' },

package/src/__tests__/composables/usePluginClient.test.ts

@@ -22,12 +22,37 @@ import { AuthenticationRequiredError } from '../../composables/useApi'
 import { useAuthStore } from '../../stores/auth'
 
 const contract: PluginContract = {
-  schemaVersion: 1,
+  schemaVersion: 2,
   plugin: {
     routesPrefix: '/drp',
     apiPrefix: '/api/drp',
     type: 'analysis',
   },
+  settings: {
+    modelName: 'PluginSettings',
+    valueSchema: {
+      type: 'object',
+      properties: {
+        threshold: { type: 'number', default: 0.05 },
+      },
+    },
+    formSchema: {
+      groups: [
+        {
+          id: 'settings',
+          label: 'Settings',
+          fields: [
+            {
+              name: 'threshold',
+              label: 'Threshold',
+              type: 'number',
+              defaultValue: 0.05,
+            },
+          ],
+        },
+      ],
+    },
+  },
   endpoints: [],
   hash: 'sha256:test',
 }
@@ -818,6 +843,16 @@ describe('usePluginClient', () => {
     })
   })
 
+  it('should preserve the contract v2 form schema in settingsConfig', () => {
+    const settings = usePluginSettings({
+      apiBaseUrl: '/api/drp',
+      loadOnMount: false,
+      schema: contract.settings.formSchema,
+    })
+
+    expect(settings.settingsConfig.value.schema).toBe(contract.settings.formSchema)
+  })
+
   it('should use the platform facade for an explicit different plugin name', async () => {
     ;(window as unknown as { __MINT_PLATFORM__?: unknown }).__MINT_PLATFORM__ = {
       isIntegrated: true,

package/src/__tests__/types/GeneratedJsonSchema.test.ts

@@ -0,0 +1,17 @@
+import { describe, expect, it } from 'vitest'
+
+import type { GeneratedJsonSchema } from '../../types/generated-ui'
+
+describe('GeneratedJsonSchema', () => {
+  it('should accept array size constraints emitted by Pydantic', () => {
+    const schema: GeneratedJsonSchema = { maxItems: 100 }
+
+    expect(schema.maxItems).toBe(100)
+  })
+
+  it('should accept write-only fields emitted by Pydantic', () => {
+    const schema: GeneratedJsonSchema = { writeOnly: true }
+
+    expect(schema.writeOnly).toBe(true)
+  })
+})

package/src/components/GeneratedPluginView.vue

@@ -116,7 +116,7 @@ function resourceSummary(definition: GeneratedJobDefinition): string {
   if (definition.lifecycle === 'staged' || definition.profile?.kind === 'staged') {
     return 'Staged upload'
   }
-  return `${definition.cpu} CPU`
+  return `Up to ${definition.cpu} CPU`
 }
 
 onMounted(() => {

package/src/components/PluginWorkspaceView.props.ts

@@ -34,7 +34,7 @@ export interface PluginWorkspaceViewProps {
   homePath?: string
   /** Show the default MINT logo when no icon/logo slot is provided. */
   showLogo?: boolean
-  /** Preferred route-level page selector entries. */
+  /** Preferred route-level page selector entries. Pass [] to suppress integrated platform fallback. */
   pageSelector?: PageSelectorItemInput[]
   /** Active page selector id. Defaults to activeView. */
   currentPageSelectorId?: string

package/src/components/PluginWorkspaceView.vue

@@ -208,10 +208,6 @@ const {
   emitPillSelect: (item) => emit('pill-select', item),
 })
 
-const visiblePageSelector = computed(() =>
-  (props.pageSelector?.length ?? 0) > 1 ? props.pageSelector : undefined,
-)
-
 const hasSidebarSurface = computed(() => {
   return hasPluginWorkspaceSidebarSurface({
     showSidebar: props.showSidebar,
@@ -274,7 +270,7 @@ function handleFormCancel(sectionId: string) {
           :variant="topBarVariant"
           :home-path="homePath"
           :show-logo="showLogo"
-          :page-selector="visiblePageSelector"
+          :page-selector="pageSelector"
           :current-page-selector-id="resolvedCurrentPageSelectorId"
           :plugin-switcher="pluginSwitcher"
           :pill-nav="resolvedPillNav"

package/src/composables/index.ts

@@ -481,6 +481,7 @@ export {
   type DownloadBlobOptions,
   type DownloadPluginEndpointOptions,
   type PluginContract,
+  type PluginContractSettings,
   type PluginClientRequestOptions,
   type PluginEndpointContract,
   type PluginEndpointDefinition,

package/src/composables/useGeneratedAnalysis.ts

@@ -75,7 +75,10 @@ export interface UsePluginJobsReturn extends PluginJobCenterSource {
   status: ShallowRef<'idle' | 'initializing' | 'ready' | 'paused' | 'error' | 'disposed'>
   initialize: () => Promise<void>
   ready: () => Promise<void>
-  uploadPath: (input: PluginJobPathInput) => Promise<PluginJobPathUpload>
+  uploadPath: (
+    input: PluginJobPathInput,
+    definitionId?: string,
+  ) => Promise<PluginJobPathUpload>
   uploadStagedPart: <Metadata>(
     input: PluginJobStagedPartInput<Metadata>,
   ) => Promise<PluginJobStagedPartUploadResult<Metadata>>
@@ -279,7 +282,7 @@ function createPluginJobs(
         jobInput = await submitToSession(
           session.value.id,
           clientRequestId,
-          await stagePathInputs(inputs, session.value.id),
+          await stagePathInputs(inputs, session.value.id, definitionId),
         )
       } catch (cause) {
         if (!isSessionNotFoundError(cause)) throw cause
@@ -287,7 +290,7 @@ function createPluginJobs(
         jobInput = await submitToSession(
           session.value.id,
           clientRequestId,
-          await stagePathInputs(inputs, session.value.id),
+          await stagePathInputs(inputs, session.value.id, definitionId),
         )
       }
       const job = upsertJob(jobInput, definitionId)
@@ -317,9 +320,12 @@ function createPluginJobs(
     }
   }
 
-  async function uploadPath(input: PluginJobPathInput): Promise<PluginJobPathUpload> {
+  async function uploadPath(
+    input: PluginJobPathInput,
+    definitionId?: string,
+  ): Promise<PluginJobPathUpload> {
     if (!session.value) throw new Error('Generated analysis session is not initialized')
-    return uploadPathForSession(input, session.value.id)
+    return uploadPathForSession(input, session.value.id, definitionId)
   }
 
   async function uploadStagedPart<Metadata>(
@@ -375,6 +381,7 @@ function createPluginJobs(
   async function uploadPathForSession(
     input: PluginJobPathInput,
     sessionId: string,
+    definitionId?: string,
   ): Promise<PluginJobPathUpload> {
     if (!input.files.length || input.files.length !== input.relativePaths.length) {
       throw new Error('Path upload requires one relative path for each file')
@@ -386,40 +393,51 @@ function createPluginJobs(
       body.append('files', input.files[index]!)
       body.append('relative_paths', input.relativePaths[index]!)
     }
+    const headers: Record<string, string> = {
+      'X-Mint-Job-Session': sessionId,
+    }
+    if (definitionId) headers['X-Mint-Job-Definition'] = definitionId
     return request<PluginJobPathUpload>('/jobs/uploads', {
       method: 'POST',
       body,
       signal: input.signal,
-      headers: { 'X-Mint-Job-Session': sessionId },
+      headers,
     })
   }
 
   async function stagePathInputs(
     inputs: Record<string, unknown>,
     sessionId: string,
+    definitionId: string,
   ): Promise<Record<string, unknown>> {
-    return await stagePathValue(inputs, sessionId) as Record<string, unknown>
+    return await stagePathValue(inputs, sessionId, definitionId) as Record<string, unknown>
   }
 
-  async function stagePathValue(value: unknown, sessionId: string): Promise<unknown> {
+  async function stagePathValue(
+    value: unknown,
+    sessionId: string,
+    definitionId: string,
+  ): Promise<unknown> {
     if (typeof File !== 'undefined' && value instanceof File) {
       const upload = await uploadPathForSession({
         kind: 'path',
         files: [value],
         relativePaths: [value.name],
-      }, sessionId)
+      }, sessionId, definitionId)
       return { token: upload.token }
     }
     if (isPluginJobPathInput(value)) {
-      const upload = await uploadPathForSession(value, sessionId)
+      const upload = await uploadPathForSession(value, sessionId, definitionId)
       return { token: upload.token }
     }
     if (Array.isArray(value)) {
-      return await Promise.all(value.map(item => stagePathValue(item, sessionId)))
+      return await Promise.all(value.map(
+        item => stagePathValue(item, sessionId, definitionId),
+      ))
     }
     if (value && typeof value === 'object') {
       const entries = await Promise.all(Object.entries(value).map(async ([key, child]) => (
-        [key, await stagePathValue(child, sessionId)] as const
+        [key, await stagePathValue(child, sessionId, definitionId)] as const
       )))
       return Object.fromEntries(entries)
     }

package/src/composables/usePluginClient.ts

@@ -45,6 +45,7 @@ export type PluginHttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete'
 
 export interface PluginEndpointContract {
   name: string
+  operationId?: string
   method: PluginHttpMethod
   path: string
   requiresAuth?: boolean
@@ -75,8 +76,16 @@ export interface PluginNavItemContract {
   requiresFeature?: string
 }
 
+export interface PluginContractSettings {
+  modelName: string | null
+  /** Pydantic JSON Schema used to generate typed settings values. */
+  valueSchema: Record<string, unknown> | null
+  /** SDK SettingsModal schema used to render the settings form. */
+  formSchema: SettingsModalSchema | null
+}
+
 export interface PluginContract {
-  schemaVersion: number
+  schemaVersion: 2
   plugin: {
     name?: string
     packageName?: string
@@ -92,11 +101,9 @@ export interface PluginContract {
     analysisResultReaders?: string[]
     capabilities?: Record<string, unknown>
   }
-  settings?: {
-    modelName?: string | null
-    schema?: SettingsModalSchema | null
-  }
+  settings: PluginContractSettings
   endpoints: PluginEndpointContract[]
+  schemas?: Record<string, Record<string, unknown>>
   jobs?: GeneratedJobDefinition[]
   hash: string
 }

package/src/types/generated-ui.ts

@@ -12,6 +12,8 @@ export interface GeneratedJsonSchema {
   maximum?: number
   minLength?: number
   maxLength?: number
+  maxItems?: number
+  writeOnly?: boolean
   properties?: Record<string, GeneratedJsonSchema>
   additionalProperties?: boolean | GeneratedJsonSchema
   required?: string[]
@@ -102,6 +104,8 @@ export interface GeneratedJobDefinition {
   title: string
   description: string
   cpu: number
+  /** Whether integrated submission requires a platform or current-plugin administrator. */
+  requires_admin?: boolean
   /** Defaults to process for manifests generated before lifecycle profiles. */
   lifecycle?: GeneratedJobLifecycle
   /** Defaults to `{ kind: 'process' }` for older manifests. */